Download OpenAPI specification:Download
This is the API that drives BloodHound Enterprise and Community Edition.
Endpoint availability is denoted using the Community and Enterprise tags.
Contact information listed is for BloodHound Enterprise customers. To get help with BloodHound Community Edition, please join our Slack community.
The BloodHound API supports two kinds of authentication: JWT bearer tokens and Signed Requests. For quick tests or one-time calls, the JWT used by your browser may be the simplest route. For more secure and long lived API integrations, the recommended option is signed requests.
The API will accept calls using the following header structure in the HTTP request:
Authorization: Bearer $JWT_TOKEN
If you open the Network tab within your browser, you will see calls against the API made utilizing this structure. JWT bearer tokens are supported by the BloodHound API, however it is recommended they only be used for temporary access. JWT tokens expire after a set amount of time and require re-authentication using secret credentials.
Signed requests are the recommended form of authentication for the BloodHound API. Not only are signed requests better for long lived integrations, they also provide more security for the requests being sent. They provide authentication of the client, as well as verification of request integrity when received by the server.
Signed requests consist of three main parts: The client token ID, the request timestamp, and a base64 encoded HMAC signature. These three pieces of information are sent with the request using the following header structure:
Authorization: bhesignature $TOKEN_ID
RequestDate: $RFC3339_DATETIME
Signature: $BASE64ENCODED_HMAC_SIGNATURE
To use signed requests, you will need to generate an API token. Each API token generated in the
BloodHound API comes with two parts: The Token ID, which is used in the Authorization header,
and the Token Key, which is used as part of the HMAC hashing process. The token ID should be
considered as public (like a username) and the token key should be considered secret (like a
password). Once an API token is generated, you can use the key to sign requests.
For more documentation about how to work with authentication in the API, including examples of how to generate an API token in the BloodHound UI, please refer to this support doc: Working with the BloodHound API.
First, a digest is initiated with HMAC-SHA-256 using the token key as the digest key:
digester = hmac.new(sha256, api_token_key)
OperationKey is the first HMAC digest link in the signature chain. This prevents replay attacks that seek to modify the request method or URI. It is composed of concatenating the request method and the request URI with no delimiter and computing the HMAC digest using the token key as the digest secret:
# Example: GET /api/v2/test/resource HTTP/1.1
# Signature Component: GET/api/v2/test/resource
digester.write(request_method + request_uri)
# Update the digester for further chaining
digester = hmac.New(sha256, digester.hash())
DateKey is the next HMAC digest link in the signature chain. This encodes the RFC3339 formatted datetime value as part of the signature to the hour to prevent replay attacks that are older than max two hours. This value is added to the signature chain by cutting off all values from the RFC3339 formatted datetime from the hours value forward:
# Example: 2020-12-01T23:59:60Z
# Signature Component: 2020-12-01T23
request_datetime = date.now()
digester.write(request_datetime[:13])
# Update the digester for further chaining
digester = hmac.New(sha256, digester.hash())
Body signing is the last HMAC digest link in the signature chain. This encodes the request body as part of the signature to prevent replay attacks that seek to modify the payload of a signed request. In the case where there is no body content the HMAC digest is computed anyway, simply with no values written to the digester:
if request.body is not empty:
digester.write(request.body)
Finally, base64 encode the final hash and write the three required headers before sending the request:
encoded_hash = base64_encode(digester.hash())
request.header.write('Authorization', 'bhesignature ' + token_id)
request.header.write('RequestDate', request_datetime)
request.header.write('Signature', encoded_hash)
Login to BloodHound with user credentials or a one time password.
| Prefer | integer [ 0 .. 60 ] Default: 30 Prefer header, used to specify a custom timeout in seconds using the wait parameter as per RFC7240. The default timeout is 30 seconds and maximum timeout is 60 seconds |
The request body for logging into the application. secret or otp is required, but not both.
| login_method required | string Value: "secret" The type of login. Currently only |
| username required | string |
| secret | string The password for the user. This field can be used instead of |
| otp | string The One Time Password for a single login. This field can be used instead of |
{- "login_method": "secret",
- "username": "cool_user@bloodhoundenterprise.io",
- "secret": "MySup3rS3cr3tPassw0rd!!!"
}{- "data": {
- "user_id": "54623566-213a-4490-9c68-ac44c39b6590",
- "auth_expired": false,
- "session_token": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJ1c2VyX2lkIjoiNTQ2MjM1NjYtMjEzYS00NDkwLTljNjgtYWM0NGMzOWI2NTkwIiwidXNlciI6ImNvb2xfdXNlckBibG9vZGhvdW5kZW50ZXJwcmlzZS5pbyIsImlhdCI6MTUxNjIzOTAyMn0.1WWo7XpE9a-v6MQ9tHC8ikxmvmS3PuD7bJyNi4hPr_Y"
}
}Logout of BloodHound and delete the user session JWT.
| Prefer | integer [ 0 .. 60 ] Default: 30 Prefer header, used to specify a custom timeout in seconds using the wait parameter as per RFC7240. The default timeout is 30 seconds and maximum timeout is 60 seconds |
[this request has no response data]
Get the currently authenticated requester details. For Community, this will only ever be valid for users. In Enterprise, this could be either a BloodHound user or a client (collector).
| Prefer | integer [ 0 .. 60 ] Default: 30 Prefer header, used to specify a custom timeout in seconds using the wait parameter as per RFC7240. The default timeout is 30 seconds and maximum timeout is 60 seconds |
{- "data": {
- "saml_provider_id": {
- "int32": 0,
- "valid": true
}, - "AuthSecret": {
- "digest_method": "string",
- "expires_at": "2019-08-24T14:15:22Z",
- "totp_activated": true,
- "id": 0,
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z",
- "deleted_at": {
- "time": "2019-08-24T14:15:22Z",
- "valid": true
}
}, - "roles": [
- {
- "name": "string",
- "description": "string",
- "permissions": [
- {
- "authority": "string",
- "name": "string",
- "id": 0,
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z",
- "deleted_at": {
- "time": "2019-08-24T14:15:22Z",
- "valid": true
}
}
], - "id": 0,
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z",
- "deleted_at": {
- "time": "2019-08-24T14:15:22Z",
- "valid": true
}
}
], - "first_name": {
- "string": "string",
- "valid": true
}, - "last_name": {
- "string": "string",
- "valid": true
}, - "email_address": {
- "string": "string",
- "valid": true
}, - "principal_name": "string",
- "last_login": "2019-08-24T14:15:22Z",
- "is_disabled": true,
- "eula_accepted": true,
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z",
- "deleted_at": {
- "time": "2019-08-24T14:15:22Z",
- "valid": true
}
}
}List all registered SAML providers.
| Prefer | integer [ 0 .. 60 ] Default: 30 Prefer header, used to specify a custom timeout in seconds using the wait parameter as per RFC7240. The default timeout is 30 seconds and maximum timeout is 60 seconds |
{- "data": {
- "saml_providers": [
- {
- "name": "string",
- "display_name": "string",
- "idp_issuer_uri": "string",
- "idp_sso_uri": "string",
- "principal_attribute_mappings": [
- "string"
], - "sp_issuer_uri": "string",
- "sp_sso_uri": "string",
- "sp_metadata_uri": "string",
- "sp_acs_uri": "string",
- "id": 0,
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z",
- "deleted_at": {
- "time": "2019-08-24T14:15:22Z",
- "valid": true
}
}
]
}
}Get all SAML sign on endpoints
| Prefer | integer [ 0 .. 60 ] Default: 30 Prefer header, used to specify a custom timeout in seconds using the wait parameter as per RFC7240. The default timeout is 30 seconds and maximum timeout is 60 seconds |
{- "data": {
- "endpoints": [
- {
- "name": "string",
- "idp_url": "string"
}
]
}
}Creates a new SAML provider with the given name and metadata XML.
| name | string Name of the new SAML provider. |
| metadata | string <binary> Metadata XML file. |
{- "data": {
- "name": "string",
- "display_name": "string",
- "idp_issuer_uri": "string",
- "idp_sso_uri": "string",
- "principal_attribute_mappings": [
- "string"
], - "sp_issuer_uri": "string",
- "sp_sso_uri": "string",
- "sp_metadata_uri": "string",
- "sp_acs_uri": "string",
- "id": 0,
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z",
- "deleted_at": {
- "time": "2019-08-24T14:15:22Z",
- "valid": true
}
}
}Get the service and identity provider configuration details for a SAML authentication provider.
| saml_provider_id required | integer <int32> SAML Provider ID |
| Prefer | integer [ 0 .. 60 ] Default: 30 Prefer header, used to specify a custom timeout in seconds using the wait parameter as per RFC7240. The default timeout is 30 seconds and maximum timeout is 60 seconds |
{- "data": {
- "name": "string",
- "display_name": "string",
- "idp_issuer_uri": "string",
- "idp_sso_uri": "string",
- "principal_attribute_mappings": [
- "string"
], - "sp_issuer_uri": "string",
- "sp_sso_uri": "string",
- "sp_metadata_uri": "string",
- "sp_acs_uri": "string",
- "id": 0,
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z",
- "deleted_at": {
- "time": "2019-08-24T14:15:22Z",
- "valid": true
}
}
}List all authorization roles.
| sort_by | string (sort-by) Sortable columns are |
| name | string (filter.string) Filter results by column string value. Valid filter predicates are |
| id | integer (filter.integer) Filter results by column integer value. Valid filter predicates are |
| created_at | string <date-time> (filter.time) Filter results by |
| updated_at | string <date-time> (filter.time) Filter results by |
| deleted_at | string <date-time> (filter.time) Filter results by |
| Prefer | integer [ 0 .. 60 ] Default: 30 Prefer header, used to specify a custom timeout in seconds using the wait parameter as per RFC7240. The default timeout is 30 seconds and maximum timeout is 60 seconds |
{- "data": {
- "roles": [
- {
- "name": "string",
- "description": "string",
- "permissions": [
- {
- "authority": "string",
- "name": "string",
- "id": 0,
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z",
- "deleted_at": {
- "time": "2019-08-24T14:15:22Z",
- "valid": true
}
}
], - "id": 0,
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z",
- "deleted_at": {
- "time": "2019-08-24T14:15:22Z",
- "valid": true
}
}
]
}
}Gets an authorization role's details.
| role_id required | integer <int32> ID of the role record to retrieve info for. |
| Prefer | integer [ 0 .. 60 ] Default: 30 Prefer header, used to specify a custom timeout in seconds using the wait parameter as per RFC7240. The default timeout is 30 seconds and maximum timeout is 60 seconds |
{- "data": {
- "name": "string",
- "description": "string",
- "permissions": [
- {
- "authority": "string",
- "name": "string",
- "id": 0,
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z",
- "deleted_at": {
- "time": "2019-08-24T14:15:22Z",
- "valid": true
}
}
], - "id": 0,
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z",
- "deleted_at": {
- "time": "2019-08-24T14:15:22Z",
- "valid": true
}
}
}List all authorization permissions.
| sort_by | string (sort-by) Sortable columns are |
| authority | string (filter.string) Filter results by column string value. Valid filter predicates are |
| name | string (filter.string) Filter results by column string value. Valid filter predicates are |
| id | integer (filter.integer) Filter results by column integer value. Valid filter predicates are |
| created_at | string <date-time> (filter.time) Filter results by |
| updated_at | string <date-time> (filter.time) Filter results by |
| deleted_at | string <date-time> (filter.time) Filter results by |
| Prefer | integer [ 0 .. 60 ] Default: 30 Prefer header, used to specify a custom timeout in seconds using the wait parameter as per RFC7240. The default timeout is 30 seconds and maximum timeout is 60 seconds |
{- "data": {
- "permissions": [
- {
- "authority": "string",
- "name": "string",
- "id": 0,
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z",
- "deleted_at": {
- "time": "2019-08-24T14:15:22Z",
- "valid": true
}
}
]
}
}Gets an authorization permission's details.
| permission_id required | integer <int32> ID of the permission record to retrieve details for. |
| Prefer | integer [ 0 .. 60 ] Default: 30 Prefer header, used to specify a custom timeout in seconds using the wait parameter as per RFC7240. The default timeout is 30 seconds and maximum timeout is 60 seconds |
{- "data": {
- "authority": "string",
- "name": "string",
- "id": 0,
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z",
- "deleted_at": {
- "time": "2019-08-24T14:15:22Z",
- "valid": true
}
}
}Create a new token to use with request signing based authentication for a given user.
| Prefer | integer [ 0 .. 60 ] Default: 30 Prefer header, used to specify a custom timeout in seconds using the wait parameter as per RFC7240. The default timeout is 30 seconds and maximum timeout is 60 seconds |
The request body for creating an auth token
| token_name | string |
| user_id | string <uuid> |
{- "token_name": "string",
- "user_id": "a169451c-8525-4352-b8ca-070dd449a1a5"
}{- "data": {
- "user_id": {
- "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
- "valid": true
}, - "name": {
- "string": "string",
- "valid": true
}, - "key": "string",
- "hmac_method": "string",
- "last_access": "2019-08-24T14:15:22Z",
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z",
- "deleted_at": {
- "time": "2019-08-24T14:15:22Z",
- "valid": true
}
}
}Delete a request signing token for a given user.
| token_id required | string <uuid> ID of auth token to delete. |
| Prefer | integer [ 0 .. 60 ] Default: 30 Prefer header, used to specify a custom timeout in seconds using the wait parameter as per RFC7240. The default timeout is 30 seconds and maximum timeout is 60 seconds |
[this request has no response data]
Gets all BloodHound user details.
| sort_by | string (sort-by) Sortable columns are first_name, last_name, email_address, principal_name, last_login, created_at, updated_at, deleted_at. |
| first_name | string (filter.string) Filter results by column string value. Valid filter predicates are |
| last_name | string (filter.string) Filter results by column string value. Valid filter predicates are |
| email_address | string (filter.string) Filter results by column string value. Valid filter predicates are |
| principal_name | string (filter.string) Filter results by column string value. Valid filter predicates are |
| id | string <uuid> (filter.uuid) Filter results by column string-formatted uuid value. Valid filter predicates are |
| last_login | string <date-time> (filter.time) Filter results by column timestamp value formatted as an RFC-3339 string.
Valid filter predicates are |
| created_at | string <date-time> (filter.time) Filter results by |
| updated_at | string <date-time> (filter.time) Filter results by |
| deleted_at | string <date-time> (filter.time) Filter results by |
| Prefer | integer [ 0 .. 60 ] Default: 30 Prefer header, used to specify a custom timeout in seconds using the wait parameter as per RFC7240. The default timeout is 30 seconds and maximum timeout is 60 seconds |
{- "data": {
- "users": [
- {
- "saml_provider_id": {
- "int32": 0,
- "valid": true
}, - "AuthSecret": {
- "digest_method": "string",
- "expires_at": "2019-08-24T14:15:22Z",
- "totp_activated": true,
- "id": 0,
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z",
- "deleted_at": {
- "time": "2019-08-24T14:15:22Z",
- "valid": true
}
}, - "roles": [
- {
- "name": "string",
- "description": "string",
- "permissions": [
- {
- "authority": "string",
- "name": "string",
- "id": 0,
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z",
- "deleted_at": {
- "time": "2019-08-24T14:15:22Z",
- "valid": true
}
}
], - "id": 0,
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z",
- "deleted_at": {
- "time": "2019-08-24T14:15:22Z",
- "valid": true
}
}
], - "first_name": {
- "string": "string",
- "valid": true
}, - "last_name": {
- "string": "string",
- "valid": true
}, - "email_address": {
- "string": "string",
- "valid": true
}, - "principal_name": "string",
- "last_login": "2019-08-24T14:15:22Z",
- "is_disabled": true,
- "eula_accepted": true,
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z",
- "deleted_at": {
- "time": "2019-08-24T14:15:22Z",
- "valid": true
}
}
]
}
}Create a new BloodHound user.
| Prefer | integer [ 0 .. 60 ] Default: 30 Prefer header, used to specify a custom timeout in seconds using the wait parameter as per RFC7240. The default timeout is 30 seconds and maximum timeout is 60 seconds |
The request body for creating a user
| first_name | string |
| last_name | string |
| email_address | string <email> |
| principal | string |
| roles | Array of integers <int32> [ items <int32 > ] |
| saml_provider_id | string |
| is_disabled | boolean |
| secret | string |
| needs_password_reset | boolean |
{- "first_name": "string",
- "last_name": "string",
- "email_address": "user@example.com",
- "principal": "string",
- "roles": [
- 0
], - "saml_provider_id": "string",
- "is_disabled": true,
- "secret": "string",
- "needs_password_reset": true
}{- "data": {
- "saml_provider_id": {
- "int32": 0,
- "valid": true
}, - "AuthSecret": {
- "digest_method": "string",
- "expires_at": "2019-08-24T14:15:22Z",
- "totp_activated": true,
- "id": 0,
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z",
- "deleted_at": {
- "time": "2019-08-24T14:15:22Z",
- "valid": true
}
}, - "roles": [
- {
- "name": "string",
- "description": "string",
- "permissions": [
- {
- "authority": "string",
- "name": "string",
- "id": 0,
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z",
- "deleted_at": {
- "time": "2019-08-24T14:15:22Z",
- "valid": true
}
}
], - "id": 0,
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z",
- "deleted_at": {
- "time": "2019-08-24T14:15:22Z",
- "valid": true
}
}
], - "first_name": {
- "string": "string",
- "valid": true
}, - "last_name": {
- "string": "string",
- "valid": true
}, - "email_address": {
- "string": "string",
- "valid": true
}, - "principal_name": "string",
- "last_login": "2019-08-24T14:15:22Z",
- "is_disabled": true,
- "eula_accepted": true,
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z",
- "deleted_at": {
- "time": "2019-08-24T14:15:22Z",
- "valid": true
}
}
}Get a BloodHound user's details.
| user_id required | string <uuid> User ID |
| Prefer | integer [ 0 .. 60 ] Default: 30 Prefer header, used to specify a custom timeout in seconds using the wait parameter as per RFC7240. The default timeout is 30 seconds and maximum timeout is 60 seconds |
{- "data": {
- "saml_provider_id": {
- "int32": 0,
- "valid": true
}, - "AuthSecret": {
- "digest_method": "string",
- "expires_at": "2019-08-24T14:15:22Z",
- "totp_activated": true,
- "id": 0,
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z",
- "deleted_at": {
- "time": "2019-08-24T14:15:22Z",
- "valid": true
}
}, - "roles": [
- {
- "name": "string",
- "description": "string",
- "permissions": [
- {
- "authority": "string",
- "name": "string",
- "id": 0,
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z",
- "deleted_at": {
- "time": "2019-08-24T14:15:22Z",
- "valid": true
}
}
], - "id": 0,
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z",
- "deleted_at": {
- "time": "2019-08-24T14:15:22Z",
- "valid": true
}
}
], - "first_name": {
- "string": "string",
- "valid": true
}, - "last_name": {
- "string": "string",
- "valid": true
}, - "email_address": {
- "string": "string",
- "valid": true
}, - "principal_name": "string",
- "last_login": "2019-08-24T14:15:22Z",
- "is_disabled": true,
- "eula_accepted": true,
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z",
- "deleted_at": {
- "time": "2019-08-24T14:15:22Z",
- "valid": true
}
}
}Update a BloodHound user's properties'.
| user_id required | string <uuid> User ID |
| Prefer | integer [ 0 .. 60 ] Default: 30 Prefer header, used to specify a custom timeout in seconds using the wait parameter as per RFC7240. The default timeout is 30 seconds and maximum timeout is 60 seconds |
The request body for updating a user
| first_name | string |
| last_name | string |
| email_address | string <email> |
| principal | string |
| roles | Array of integers <int32> [ items <int32 > ] |
| saml_provider_id | string |
| is_disabled | boolean |
{- "first_name": "string",
- "last_name": "string",
- "email_address": "user@example.com",
- "principal": "string",
- "roles": [
- 0
], - "saml_provider_id": "string",
- "is_disabled": true
}[this request has no response data]
Deletes an existing BloodHound user.
| user_id required | string <uuid> User ID |
| Prefer | integer [ 0 .. 60 ] Default: 30 Prefer header, used to specify a custom timeout in seconds using the wait parameter as per RFC7240. The default timeout is 30 seconds and maximum timeout is 60 seconds |
[this request has no response data]
Create or set a user's secret to use as a login password.
| user_id required | string <uuid> User ID |
| Prefer | integer [ 0 .. 60 ] Default: 30 Prefer header, used to specify a custom timeout in seconds using the wait parameter as per RFC7240. The default timeout is 30 seconds and maximum timeout is 60 seconds |
The request body for creating or setting a user secret
| secret | string |
| needs_password_reset | boolean |
{- "secret": "string",
- "needs_password_reset": true
}[this request has no response data]
Expire a user's secret to use as a login password.
| user_id required | string <uuid> User ID |
| Prefer | integer [ 0 .. 60 ] Default: 30 Prefer header, used to specify a custom timeout in seconds using the wait parameter as per RFC7240. The default timeout is 30 seconds and maximum timeout is 60 seconds |
[this request has no response data]
Enrolls user in multi-factor authentication
| user_id required | string <uuid> User ID |
| Prefer | integer [ 0 .. 60 ] Default: 30 Prefer header, used to specify a custom timeout in seconds using the wait parameter as per RFC7240. The default timeout is 30 seconds and maximum timeout is 60 seconds |
The request body for enrolling a user in multi-factor authentication
| secret | string |
{- "secret": "string"
}{- "data": {
- "qr_code": "string",
- "totp_secret": "string"
}
}Unenrolls user from multi-factor authentication
| user_id required | string <uuid> User ID |
| Prefer | integer [ 0 .. 60 ] Default: 30 Prefer header, used to specify a custom timeout in seconds using the wait parameter as per RFC7240. The default timeout is 30 seconds and maximum timeout is 60 seconds |
The request body for unenrolling a user from multi-factor authentication
| secret | string |
{- "secret": "string"
}{- "data": {
- "status": "activated"
}
}Returns multi-factor authentication status for a user
| user_id required | string <uuid> User ID |
| Prefer | integer [ 0 .. 60 ] Default: 30 Prefer header, used to specify a custom timeout in seconds using the wait parameter as per RFC7240. The default timeout is 30 seconds and maximum timeout is 60 seconds |
{- "data": {
- "status": "activated"
}
}Activates multi-factor authentication for an enrolled user
| user_id required | string <uuid> User ID |
| Prefer | integer [ 0 .. 60 ] Default: 30 Prefer header, used to specify a custom timeout in seconds using the wait parameter as per RFC7240. The default timeout is 30 seconds and maximum timeout is 60 seconds |
The request body for activating multi-factor authentication for an enrolled user
| otp | string |
{- "otp": "string"
}{- "data": {
- "status": "activated"
}
}Retrieves the version manifest for a given collector
| collector_type required | string (client-type) Enum: "sharphound" "azurehound" Collector type |
| Prefer | integer [ 0 .. 60 ] Default: 30 Prefer header, used to specify a custom timeout in seconds using the wait parameter as per RFC7240. The default timeout is 30 seconds and maximum timeout is 60 seconds |
{- "data": {
- "latest": "string",
- "versions": [
- {
- "version": "string",
- "sha256sum": "string",
- "deprecated": true
}
]
}
}Retrieves the download for a given collector with given version
| collector_type required | string (client-type) Enum: "sharphound" "azurehound" Collector type |
| release_tag required | string Release tag (semver or "latest") |
| Prefer | integer [ 0 .. 60 ] Default: 30 Prefer header, used to specify a custom timeout in seconds using the wait parameter as per RFC7240. The default timeout is 30 seconds and maximum timeout is 60 seconds |
[this request has a binary response]
Retrieves the checksum file for a given collector with given version
| collector_type required | string (client-type) Enum: "sharphound" "azurehound" Collector type |
| release_tag required | string Release tag (semver or "latest") |
| Prefer | integer [ 0 .. 60 ] Default: 30 Prefer header, used to specify a custom timeout in seconds using the wait parameter as per RFC7240. The default timeout is 30 seconds and maximum timeout is 60 seconds |
[this request has a binary response]
Lists available file upload jobs
| sort_by | string (sort-by) Sortable columns are |
| user_id | string (filter.string) Filter results by column string value. Valid filter predicates are |
| user_email_address | string (filter.string) Filter results by column string value. Valid filter predicates are |
| status | integer (filter.integer) Filter results by column integer value. Valid filter predicates are |
| status_message | string (filter.string) Filter results by column string value. Valid filter predicates are |
| start_time | string <date-time> (filter.time) Filter results by column timestamp value formatted as an RFC-3339 string.
Valid filter predicates are |
| end_time | string <date-time> (filter.time) Filter results by column timestamp value formatted as an RFC-3339 string.
Valid filter predicates are |
| last_ingest | string <date-time> (filter.time) Filter results by column timestamp value formatted as an RFC-3339 string.
Valid filter predicates are |
| id | integer (filter.integer) Filter results by column integer value. Valid filter predicates are |
| created_at | string <date-time> (filter.time) Filter results by |
| updated_at | string <date-time> (filter.time) Filter results by |
| deleted_at | string <date-time> (filter.time) Filter results by |
| skip | integer (skip) >= 0 This query parameter is used for determining the number of objects to skip in pagination. |
| limit | integer (limit) >= 0 This query parameter is used for setting an upper limit of objects returned in paginated responses. |
| Prefer | integer [ 0 .. 60 ] Default: 30 Prefer header, used to specify a custom timeout in seconds using the wait parameter as per RFC7240. The default timeout is 30 seconds and maximum timeout is 60 seconds |
{- "data": [
- {
- "user_id": "a169451c-8525-4352-b8ca-070dd449a1a5",
- "user_email_address": "user@example.com",
- "status": -1,
- "status_message": "string",
- "start_time": "2019-08-24T14:15:22Z",
- "end_time": "2019-08-24T14:15:22Z",
- "last_ingest": "2019-08-24T14:15:22Z",
- "id": 0,
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z",
- "deleted_at": {
- "time": "2019-08-24T14:15:22Z",
- "valid": true
}
}
], - "count": 0,
- "skip": 0,
- "limit": 0
}Creates a file upload job for sending collection files
| Prefer | integer [ 0 .. 60 ] Default: 30 Prefer header, used to specify a custom timeout in seconds using the wait parameter as per RFC7240. The default timeout is 30 seconds and maximum timeout is 60 seconds |
{- "data": {
- "user_id": "a169451c-8525-4352-b8ca-070dd449a1a5",
- "user_email_address": "user@example.com",
- "status": -1,
- "status_message": "string",
- "start_time": "2019-08-24T14:15:22Z",
- "end_time": "2019-08-24T14:15:22Z",
- "last_ingest": "2019-08-24T14:15:22Z",
- "id": 0,
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z",
- "deleted_at": {
- "time": "2019-08-24T14:15:22Z",
- "valid": true
}
}
}Saves a collection file to a file upload job
| file_upload_job_id required | integer <int64> The ID for the file upload job. |
| Prefer | integer [ 0 .. 60 ] Default: 30 Prefer header, used to specify a custom timeout in seconds using the wait parameter as per RFC7240. The default timeout is 30 seconds and maximum timeout is 60 seconds |
The body of the file upload request.
{ }[this request has no response data]
End a file upload job
| file_upload_job_id required | integer <int64> The ID for the file upload job. |
| Prefer | integer [ 0 .. 60 ] Default: 30 Prefer header, used to specify a custom timeout in seconds using the wait parameter as per RFC7240. The default timeout is 30 seconds and maximum timeout is 60 seconds |
[this request has no response data]
List accepted file types for collection file uploads
| Prefer | integer [ 0 .. 60 ] Default: 30 Prefer header, used to specify a custom timeout in seconds using the wait parameter as per RFC7240. The default timeout is 30 seconds and maximum timeout is 60 seconds |
{- "data": [
- "string"
]
}Returns the supported API versions.
| Prefer | integer [ 0 .. 60 ] Default: 30 Prefer header, used to specify a custom timeout in seconds using the wait parameter as per RFC7240. The default timeout is 30 seconds and maximum timeout is 60 seconds |
{- "data": {
- "API": {
- "current_version": "string",
- "deprecated_version": "string"
}, - "server_version": "string"
}
}Returns an Open API 3.0 compatible BloodHound API spec
| Prefer | integer [ 0 .. 60 ] Default: 30 Prefer header, used to specify a custom timeout in seconds using the wait parameter as per RFC7240. The default timeout is 30 seconds and maximum timeout is 60 seconds |
openapi: 3.0.3 servers: - url: / ...[truncated example]
Search for graph objects by name or object ID, filtered by type.
| q required | string Search parameter for the name or object ID of a node. |
| type | string Node type.
Some AD examples: |
| skip | integer (skip) >= 0 This query parameter is used for determining the number of objects to skip in pagination. |
| limit | integer (limit) >= 0 This query parameter is used for setting an upper limit of objects returned in paginated responses. |
| Prefer | integer [ 0 .. 60 ] Default: 30 Prefer header, used to specify a custom timeout in seconds using the wait parameter as per RFC7240. The default timeout is 30 seconds and maximum timeout is 60 seconds |
{- "data": [
- {
- "objectid": "string",
- "type": "string",
- "name": "string",
- "distinguishedname": "string",
- "system_tags": "string"
}
]
}Gets available domains along with their collection status
| sort_by | string (filter.string) Sortable columns are objectid, name. |
| objectid | string (filter.string) Filter results by column string value. Valid filter predicates are |
| name | string (filter.string) Filter results by column string value. Valid filter predicates are |
| collected | string (filter.string) Filter results by column string value. Valid filter predicates are |
| Prefer | integer [ 0 .. 60 ] Default: 30 Prefer header, used to specify a custom timeout in seconds using the wait parameter as per RFC7240. The default timeout is 30 seconds and maximum timeout is 60 seconds |
{- "data": [
- {
- "type": "string",
- "name": "string",
- "id": "string",
- "collected": true
}
]
}Returns a list of audit logs.
| skip | integer (skip) >= 0 This query parameter is used for determining the number of objects to skip in pagination. |
| limit | integer (limit) >= 0 This query parameter is used for setting an upper limit of objects returned in paginated responses. |
| created_at | string <date-time> (filter.time) Filter results by |
| sort_by | string (sort-by) Sortable columns are |
| before | string <date-time> Return logs created before the specified time. Value should be in the RFC-3339 format. If not supplied, this will default to the current time. |
| after | string <date-time> Return logs created after the specified time. Value should be in the RFC-3339 format. If not supplied, this will default to 1 year before the current time. |
| id | string (filter.string) Filter results by column string value. Valid filter predicates are |
| actor_id | string (filter.string) Filter results by column string value. Valid filter predicates are |
| actor_name | string (filter.string) Filter results by column string value. Valid filter predicates are |
| actor_email | string (filter.string) Filter results by column string value. Valid filter predicates are |
| action | string (filter.string) Filter results by column string value. Valid filter predicates are |
| request_id | string (filter.string) Filter results by column string value. Valid filter predicates are |
| source | string (filter.string) Filter results by column string value. Valid filter predicates are |
| status | string (filter.string) Filter results by column value. Valid filter predicates are |
| Prefer | integer [ 0 .. 60 ] Default: 30 Prefer header, used to specify a custom timeout in seconds using the wait parameter as per RFC7240. The default timeout is 30 seconds and maximum timeout is 60 seconds |
{- "data": {
- "logs": [
- {
- "created_at": "2019-08-24T14:15:22Z",
- "actor_id": "04f37679-bfbf-4906-b749-01756515cecf",
- "actor_name": "string",
- "actor_email": "user@example.com",
- "action": "string",
- "fields": { },
- "request_id": "266ea41d-adf5-480b-af50-15b940c2b846",
- "source_ip_address": "192.168.0.1",
- "commit_id": "7be25ca4-a873-457e-be69-1432462588dc",
- "status": "intent",
- "id": 0
}
]
}
}Lists application configuration parameters for this instance
| parameter | string Parameter filter. Must follow the convention: parameter=eq:value |
| Prefer | integer [ 0 .. 60 ] Default: 30 Prefer header, used to specify a custom timeout in seconds using the wait parameter as per RFC7240. The default timeout is 30 seconds and maximum timeout is 60 seconds |
{- "data": [
- {
- "key": "string",
- "value": { },
- "name": "string",
- "description": "string",
- "id": 0,
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z",
- "deleted_at": {
- "time": "2019-08-24T14:15:22Z",
- "valid": true
}
}
]
}Lists all feature flags for this instance
| Prefer | integer [ 0 .. 60 ] Default: 30 Prefer header, used to specify a custom timeout in seconds using the wait parameter as per RFC7240. The default timeout is 30 seconds and maximum timeout is 60 seconds |
{- "data": [
- {
- "key": "string",
- "name": "string",
- "description": "string",
- "enabled": true,
- "user_updatable": true,
- "id": 0,
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z",
- "deleted_at": {
- "time": "2019-08-24T14:15:22Z",
- "valid": true
}
}
]
}Writes application configuration parameters for this instance
| feature_id required | integer <int32> Feature ID |
| Prefer | integer [ 0 .. 60 ] Default: 30 Prefer header, used to specify a custom timeout in seconds using the wait parameter as per RFC7240. The default timeout is 30 seconds and maximum timeout is 60 seconds |
{- "data": {
- "enabled": true
}
}Lists all asset isolation groups.
| sort_by | string (sort-by) Sortable columns are |
| name | string (filter.string) Filter results by column string value. Valid filter predicates are |
| tag | string (filter.string) Filter results by column string value. Valid filter predicates are |
| system_group | string (filter.string) Filter results by column string value. Valid filter predicates are |
| member_count | integer (filter.integer) Filter results by column integer value. Valid filter predicates are |
| id | integer (filter.integer) Filter results by column integer value. Valid filter predicates are |
| created_at | string <date-time> (filter.time) Filter results by |
| updated_at | string <date-time> (filter.time) Filter results by |
| deleted_at | string <date-time> (filter.time) Filter results by |
| Prefer | integer [ 0 .. 60 ] Default: 30 Prefer header, used to specify a custom timeout in seconds using the wait parameter as per RFC7240. The default timeout is 30 seconds and maximum timeout is 60 seconds |
{- "data": {
- "asset_groups": [
- {
- "name": "string",
- "tag": "string",
- "system_group": true,
- "selectors": [
- {
- "asset_group_id": 0,
- "name": "string",
- "selector": "string",
- "system_selector": true,
- "id": 0,
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z",
- "deleted_at": {
- "time": "2019-08-24T14:15:22Z",
- "valid": true
}
}
], - "member_count": 0,
- "id": 0,
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z",
- "deleted_at": {
- "time": "2019-08-24T14:15:22Z",
- "valid": true
}
}
]
}
}Creates an asset group
| Prefer | integer [ 0 .. 60 ] Default: 30 Prefer header, used to specify a custom timeout in seconds using the wait parameter as per RFC7240. The default timeout is 30 seconds and maximum timeout is 60 seconds |
The request body for creating an asset group
| name | string |
| tag | string |
{- "name": "string",
- "tag": "string"
}{- "data": {
- "name": "string",
- "tag": "string",
- "system_group": true,
- "selectors": [
- {
- "asset_group_id": 0,
- "name": "string",
- "selector": "string",
- "system_selector": true,
- "id": 0,
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z",
- "deleted_at": {
- "time": "2019-08-24T14:15:22Z",
- "valid": true
}
}
], - "member_count": 0,
- "id": 0,
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z",
- "deleted_at": {
- "time": "2019-08-24T14:15:22Z",
- "valid": true
}
}
}Retrieve asset group by ID
| asset_group_id required | integer <int32> ID of the asset group record to retrieve |
| Prefer | integer [ 0 .. 60 ] Default: 30 Prefer header, used to specify a custom timeout in seconds using the wait parameter as per RFC7240. The default timeout is 30 seconds and maximum timeout is 60 seconds |
{- "data": {
- "name": "string",
- "tag": "string",
- "system_group": true,
- "selectors": [
- {
- "asset_group_id": 0,
- "name": "string",
- "selector": "string",
- "system_selector": true,
- "id": 0,
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z",
- "deleted_at": {
- "time": "2019-08-24T14:15:22Z",
- "valid": true
}
}
], - "member_count": 0,
- "id": 0,
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z",
- "deleted_at": {
- "time": "2019-08-24T14:15:22Z",
- "valid": true
}
}
}Updates an asset group
| asset_group_id required | integer <int32> ID of the asset group record to retrieve |
| Prefer | integer [ 0 .. 60 ] Default: 30 Prefer header, used to specify a custom timeout in seconds using the wait parameter as per RFC7240. The default timeout is 30 seconds and maximum timeout is 60 seconds |
The request body for updating an asset group.
| name | string |
{- "name": "string"
}{- "data": {
- "name": "string",
- "tag": "string",
- "system_group": true,
- "selectors": [
- {
- "asset_group_id": 0,
- "name": "string",
- "selector": "string",
- "system_selector": true,
- "id": 0,
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z",
- "deleted_at": {
- "time": "2019-08-24T14:15:22Z",
- "valid": true
}
}
], - "member_count": 0,
- "id": 0,
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z",
- "deleted_at": {
- "time": "2019-08-24T14:15:22Z",
- "valid": true
}
}
}Deletes an asset group
| asset_group_id required | integer <int32> ID of the asset group record to retrieve |
| Prefer | integer [ 0 .. 60 ] Default: 30 Prefer header, used to specify a custom timeout in seconds using the wait parameter as per RFC7240. The default timeout is 30 seconds and maximum timeout is 60 seconds |
[this request has no response data]
Returns all historical memberships if no URL params are specified.
| asset_group_id required | integer <int32> ID of the asset_group record to retrieve |
| sort_by | string (sort-by) Sort by column. Can be used multiple times; prepend a hyphen for descending order. See parameter description for details about which columns are sortable. |
| id | integer (filter.integer) Filter results by column integer value. Valid filter predicates are |
| created_at | string <date-time> (filter.time) Filter results by |
| updated_at | string <date-time> (filter.time) Filter results by |
| deleted_at | string <date-time> (filter.time) Filter results by |
| Prefer | integer [ 0 .. 60 ] Default: 30 Prefer header, used to specify a custom timeout in seconds using the wait parameter as per RFC7240. The default timeout is 30 seconds and maximum timeout is 60 seconds |
{- "data": [
- {
- "entries": [
- {
- "object_id": "string",
- "node_label": "string",
- "properties": { },
- "id": 0,
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z",
- "deleted_at": {
- "time": "2019-08-24T14:15:22Z",
- "valid": true
}
}
], - "id": 0,
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z",
- "deleted_at": {
- "time": "2019-08-24T14:15:22Z",
- "valid": true
}
}
]
}DEPRECATED use PUT instead. Updates asset group selectors.
| asset_group_id required | integer <int32> ID of the asset_group record to retrieve |
| Prefer | integer [ 0 .. 60 ] Default: 30 Prefer header, used to specify a custom timeout in seconds using the wait parameter as per RFC7240. The default timeout is 30 seconds and maximum timeout is 60 seconds |
The request body for updating asset group selectors
| selector_name | string |
| sid | string |
| action | string Enum: "add" "remove" |
[- {
- "selector_name": "string",
- "sid": "string",
- "action": "add"
}
]{- "data": {
- "added_selectors": [
- {
- "asset_group_id": 0,
- "name": "string",
- "selector": "string",
- "system_selector": true,
- "id": 0,
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z",
- "deleted_at": {
- "time": "2019-08-24T14:15:22Z",
- "valid": true
}
}
], - "removed_selectors": [
- {
- "asset_group_id": 0,
- "name": "string",
- "selector": "string",
- "system_selector": true,
- "id": 0,
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z",
- "deleted_at": {
- "time": "2019-08-24T14:15:22Z",
- "valid": true
}
}
]
}
}Updates asset group selectors
| asset_group_id required | integer <int32> ID of the asset_group record to retrieve |
| Prefer | integer [ 0 .. 60 ] Default: 30 Prefer header, used to specify a custom timeout in seconds using the wait parameter as per RFC7240. The default timeout is 30 seconds and maximum timeout is 60 seconds |
The request body for updating asset group selectors
| selector_name | string |
| sid | string |
| action | string Enum: "add" "remove" |
[- {
- "selector_name": "string",
- "sid": "string",
- "action": "add"
}
]{- "data": {
- "added_selectors": [
- {
- "asset_group_id": 0,
- "name": "string",
- "selector": "string",
- "system_selector": true,
- "id": 0,
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z",
- "deleted_at": {
- "time": "2019-08-24T14:15:22Z",
- "valid": true
}
}
], - "removed_selectors": [
- {
- "asset_group_id": 0,
- "name": "string",
- "selector": "string",
- "system_selector": true,
- "id": 0,
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z",
- "deleted_at": {
- "time": "2019-08-24T14:15:22Z",
- "valid": true
}
}
]
}
}Deletes an asset group selector
| asset_group_id required | integer <int32> ID of the asset_group record to retrieve |
| asset_group_selector_id required | integer <int32> ID of the asset_group_selector record to retrieve |
| Prefer | integer [ 0 .. 60 ] Default: 30 Prefer header, used to specify a custom timeout in seconds using the wait parameter as per RFC7240. The default timeout is 30 seconds and maximum timeout is 60 seconds |
[this request has no response data]
Get asset group custom member count
| asset_group_id required | integer <int32> ID of the asset_group record to retrieve |
| Prefer | integer [ 0 .. 60 ] Default: 30 Prefer header, used to specify a custom timeout in seconds using the wait parameter as per RFC7240. The default timeout is 30 seconds and maximum timeout is 60 seconds |
{- "custom_member_count": 0
}List all members of an asset isolation group.
| asset_group_id required | integer <int32> ID of the asset_group record to retrieve |
| skip | integer (skip) >= 0 This query parameter is used for determining the number of objects to skip in pagination. |
| limit | integer (limit) >= 0 This query parameter is used for setting an upper limit of objects returned in paginated responses. |
| sort_by | string (sort-by) Sortable columns are |
| object_id | string (filter.string) Filter results by column string value. Valid filter predicates are |
| primary_kind | string (filter.string) Filter results by column string value. Valid filter predicates are |
| environment_id | string (filter.string) Filter results by column string value. Valid filter predicates are |
| environment_kind | string (filter.string) Filter results by column string value. Valid filter predicates are |
| name | string (filter.string) Filter results by column string value. Valid filter predicates are |
| custom_member | string (filter.string) Filter results by column string value. Valid filter predicates are |
| Prefer | integer [ 0 .. 60 ] Default: 30 Prefer header, used to specify a custom timeout in seconds using the wait parameter as per RFC7240. The default timeout is 30 seconds and maximum timeout is 60 seconds |
{- "data": {
- "members": [
- {
- "asset_group_id": 0,
- "object_id": "string",
- "primary_kind": "string",
- "kinds": [
- "string"
], - "environment_id": "string",
- "environment_kind": "string",
- "name": "string",
- "custom_member": true
}
]
}, - "count": 0,
- "skip": 0,
- "limit": 0
}List counts of members of an asset isolation group by primary kind.
| asset_group_id required | integer <int32> ID of the asset_group record to retrieve |
| object_id | string (filter.string) Filter results by column string value. Valid filter predicates are |
| environment_id | string (filter.string) Filter results by column string value. Valid filter predicates are |
| primary_kind | string (filter.string) Filter results by column string value. Valid filter predicates are |
| environment_kind | string (filter.string) Filter results by column string value. Valid filter predicates are |
| name | string (filter.string) Filter results by column string value. Valid filter predicates are |
| custom_member | string (filter.string) Filter results by column string value. Valid filter predicates are |
| Prefer | integer [ 0 .. 60 ] Default: 30 Prefer header, used to specify a custom timeout in seconds using the wait parameter as per RFC7240. The default timeout is 30 seconds and maximum timeout is 60 seconds |
{- "data": {
- "total_count": 0,
- "counts": {
- "property1": 0,
- "property2": 0
}
}
}DEPRECATED use GetShortestPath instead. Get the result of pathfinding between two nodes in graph format.
| start_node required | string Start Node |
| end_node required | string End Node |
| Prefer | integer [ 0 .. 60 ] Default: 30 Prefer header, used to specify a custom timeout in seconds using the wait parameter as per RFC7240. The default timeout is 30 seconds and maximum timeout is 60 seconds |
{- "data": {
- "property1": {
- "border": {
- "color": "string",
- "lineStyle": "string",
- "width": 0
}, - "coordinates": {
- "lat": 0,
- "lng": 0
}, - "cutout": true,
- "fontIcon": {
- "color": "string",
- "fontFamily": "string",
- "text": "string"
}, - "halos": [
- {
- "color": "string",
- "radius": 0,
- "width": 0
}
], - "image": "string",
- "label": {
- "backgroundColor": "string",
- "bold": true,
- "center": true,
- "color": "string",
- "fontFamily": "string",
- "fontSize": 0,
- "text": "string"
}, - "shape": "string",
- "size": 0,
- "color": "string",
- "fade": true,
- "data": {
- "property1": { },
- "property2": { }
}, - "glyphs": [
- {
- "angle": 0,
- "blink": true,
- "border": {
- "color": "string"
}, - "color": "string",
- "fontIcon": {
- "color": "string",
- "fontFamily": "string",
- "text": "string"
}, - "image": "string",
- "label": {
- "bold": true,
- "color": "string",
- "fontFamily": "string",
- "text": "string"
}, - "position": "string",
- "radius": 0,
- "size": 0
}
]
}, - "property2": {
- "border": {
- "color": "string",
- "lineStyle": "string",
- "width": 0
}, - "coordinates": {
- "lat": 0,
- "lng": 0
}, - "cutout": true,
- "fontIcon": {
- "color": "string",
- "fontFamily": "string",
- "text": "string"
}, - "halos": [
- {
- "color": "string",
- "radius": 0,
- "width": 0
}
], - "image": "string",
- "label": {
- "backgroundColor": "string",
- "bold": true,
- "center": true,
- "color": "string",
- "fontFamily": "string",
- "fontSize": 0,
- "text": "string"
}, - "shape": "string",
- "size": 0,
- "color": "string",
- "fade": true,
- "data": {
- "property1": { },
- "property2": { }
}, - "glyphs": [
- {
- "angle": 0,
- "blink": true,
- "border": {
- "color": "string"
}, - "color": "string",
- "fontIcon": {
- "color": "string",
- "fontFamily": "string",
- "text": "string"
}, - "image": "string",
- "label": {
- "bold": true,
- "color": "string",
- "fontFamily": "string",
- "text": "string"
}, - "position": "string",
- "radius": 0,
- "size": 0
}
]
}
}
}Get the result of searching a graph for a node by name
| search_query required | string Search query |
| type | string Enum: "fuzzy" "exact" The type of search strategy to use. Default is |
| Prefer | integer [ 0 .. 60 ] Default: 30 Prefer header, used to specify a custom timeout in seconds using the wait parameter as per RFC7240. The default timeout is 30 seconds and maximum timeout is 60 seconds |
{- "data": {
- "property1": {
- "border": {
- "color": "string",
- "lineStyle": "string",
- "width": 0
}, - "coordinates": {
- "lat": 0,
- "lng": 0
}, - "cutout": true,
- "fontIcon": {
- "color": "string",
- "fontFamily": "string",
- "text": "string"
}, - "halos": [
- {
- "color": "string",
- "radius": 0,
- "width": 0
}
], - "image": "string",
- "label": {
- "backgroundColor": "string",
- "bold": true,
- "center": true,
- "color": "string",
- "fontFamily": "string",
- "fontSize": 0,
- "text": "string"
}, - "shape": "string",
- "size": 0,
- "color": "string",
- "fade": true,
- "data": {
- "property1": { },
- "property2": { }
}, - "glyphs": [
- {
- "angle": 0,
- "blink": true,
- "border": {
- "color": "string"
}, - "color": "string",
- "fontIcon": {
- "color": "string",
- "fontFamily": "string",
- "text": "string"
}, - "image": "string",
- "label": {
- "bold": true,
- "color": "string",
- "fontFamily": "string",
- "text": "string"
}, - "position": "string",
- "radius": 0,
- "size": 0
}
]
}, - "property2": {
- "border": {
- "color": "string",
- "lineStyle": "string",
- "width": 0
}, - "coordinates": {
- "lat": 0,
- "lng": 0
}, - "cutout": true,
- "fontIcon": {
- "color": "string",
- "fontFamily": "string",
- "text": "string"
}, - "halos": [
- {
- "color": "string",
- "radius": 0,
- "width": 0
}
], - "image": "string",
- "label": {
- "backgroundColor": "string",
- "bold": true,
- "center": true,
- "color": "string",
- "fontFamily": "string",
- "fontSize": 0,
- "text": "string"
}, - "shape": "string",
- "size": 0,
- "color": "string",
- "fade": true,
- "data": {
- "property1": { },
- "property2": { }
}, - "glyphs": [
- {
- "angle": 0,
- "blink": true,
- "border": {
- "color": "string"
}, - "color": "string",
- "fontIcon": {
- "color": "string",
- "fontFamily": "string",
- "text": "string"
}, - "image": "string",
- "label": {
- "bold": true,
- "color": "string",
- "fontFamily": "string",
- "text": "string"
}, - "position": "string",
- "radius": 0,
- "size": 0
}
]
}
}
}A graph of the shortest path from start_node to end_node.
| start_node required | integer <int32> The start node objectId |
| end_node required | integer <int32> The end node objectId |
| relationship_kinds | string (filter.contains) ^(in|nin):(\w+)(,\s*\w+)*$ The contains predicate checks a property against the values in a given comma separated list.
|
| Prefer | integer [ 0 .. 60 ] Default: 30 Prefer header, used to specify a custom timeout in seconds using the wait parameter as per RFC7240. The default timeout is 30 seconds and maximum timeout is 60 seconds |
{- "data": {
- "nodes": {
- "property1": {
- "label": "string",
- "kind": "string",
- "objectId": "string",
- "isTierZero": "string",
- "lastSeen": "2019-08-24T14:15:22Z",
- "properties": {
- "property1": { },
- "property2": { }
}
}, - "property2": {
- "label": "string",
- "kind": "string",
- "objectId": "string",
- "isTierZero": "string",
- "lastSeen": "2019-08-24T14:15:22Z",
- "properties": {
- "property1": { },
- "property2": { }
}
}
}, - "edges": [
- {
- "source": "string",
- "target": "string",
- "label": "string",
- "kind": "string",
- "lastSeen": "2019-08-24T14:15:22Z",
- "properties": {
- "property1": { },
- "property2": { }
}
}
]
}
}Returns a graph representing the various nodes and edges that make up the complex post-processed edge.
| source_node required | integer <int32> The ID of the starting node. |
| target_node required | integer <int32> The ID of the ending node. |
| edge_type required | string The type of edge to show the composition for. |
| Prefer | integer [ 0 .. 60 ] Default: 30 Prefer header, used to specify a custom timeout in seconds using the wait parameter as per RFC7240. The default timeout is 30 seconds and maximum timeout is 60 seconds |
{- "data": {
- "nodes": {
- "property1": {
- "label": "string",
- "kind": "string",
- "objectId": "string",
- "isTierZero": "string",
- "lastSeen": "2019-08-24T14:15:22Z",
- "properties": {
- "property1": { },
- "property2": { }
}
}, - "property2": {
- "label": "string",
- "kind": "string",
- "objectId": "string",
- "isTierZero": "string",
- "lastSeen": "2019-08-24T14:15:22Z",
- "properties": {
- "property1": { },
- "property2": { }
}
}
}, - "edges": [
- {
- "source": "string",
- "target": "string",
- "label": "string",
- "kind": "string",
- "lastSeen": "2019-08-24T14:15:22Z",
- "properties": {
- "property1": { },
- "property2": { }
}
}
]
}
}Retrieves entity information for the given Azure object ID.
If related_entity_type parameter is not set, this endpoint will return information
about a single entity. Using the counts boolean parameter will further modify the response.
If related_entity_type parameter is set, this endpoint will return information about entities
related to a single entity. The type parameter will morph the response data structure. The list
value for the type parameter also accepts skip and limit parameters.
| entity_type required | string Entity Type |
| object_id required | string The object ID of the entity being operated on. |
| counts | boolean Returns related entity counts. Does not work with |
| related_entity_type | string Flags the query to return related entity information based on the type passed. |
| type | string Default: "list" Enum: "list" "graph" The type of return data expected. Only works with |
| skip | integer (skip) >= 0 This query parameter is used for determining the number of objects to skip in pagination.
Only compatible with |
| limit | integer >= 0 Default: 100 This query parameter is used for setting an upper limit of objects returned in paginated responses.
Only compatible with |
| Prefer | integer [ 0 .. 60 ] Default: 30 Prefer header, used to specify a custom timeout in seconds using the wait parameter as per RFC7240. The default timeout is 30 seconds and maximum timeout is 60 seconds |
{- "data": {
- "kind": "string",
- "properties": {
- "property1": { },
- "property2": { }
}, - "property1": 0,
- "property2": 0
}
}Get basic info and counts for this node.
| object_id required | string (object-id) The object id of the entity being operated on. |
| counts | boolean Default: true Include counts of related entities. Default value is |
| Prefer | integer [ 0 .. 60 ] Default: 30 Prefer header, used to specify a custom timeout in seconds using the wait parameter as per RFC7240. The default timeout is 30 seconds and maximum timeout is 60 seconds |
{- "data": {
- "props": {
- "property1": { },
- "property2": { }
}, - "property1": 0,
- "property2": 0
}
}Get a list, graph, or count of the principals this node can control.
| object_id required | string (object-id) The object id of the entity being operated on. |
| skip | integer >= 0 Default: 0 The number of entries to skip for pagination. Only available for |
| limit | integer >= 0 Default: 10 The number of entries to limit in the response. Only available for |
| type | string Default: "list" Enum: "list" "graph" "count" The type of return data requested. If no type is provided, query will default to |
| sort_by | string (sort-by) Sort by column. Can be used multiple times; prepend a hyphen for descending order. Columns available for sorting are dependent on the entity object kind. |
| Prefer | integer [ 0 .. 60 ] Default: 30 Prefer header, used to specify a custom timeout in seconds using the wait parameter as per RFC7240. The default timeout is 30 seconds and maximum timeout is 60 seconds |
{- "property1": {
- "border": {
- "color": "string",
- "lineStyle": "string",
- "width": 0
}, - "coordinates": {
- "lat": 0,
- "lng": 0
}, - "cutout": true,
- "fontIcon": {
- "color": "string",
- "fontFamily": "string",
- "text": "string"
}, - "halos": [
- {
- "color": "string",
- "radius": 0,
- "width": 0
}
], - "image": "string",
- "label": {
- "backgroundColor": "string",
- "bold": true,
- "center": true,
- "color": "string",
- "fontFamily": "string",
- "fontSize": 0,
- "text": "string"
}, - "shape": "string",
- "size": 0,
- "color": "string",
- "fade": true,
- "data": {
- "property1": { },
- "property2": { }
}, - "glyphs": [
- {
- "angle": 0,
- "blink": true,
- "border": {
- "color": "string"
}, - "color": "string",
- "fontIcon": {
- "color": "string",
- "fontFamily": "string",
- "text": "string"
}, - "image": "string",
- "label": {
- "bold": true,
- "color": "string",
- "fontFamily": "string",
- "text": "string"
}, - "position": "string",
- "radius": 0,
- "size": 0
}
]
}, - "property2": {
- "border": {
- "color": "string",
- "lineStyle": "string",
- "width": 0
}, - "coordinates": {
- "lat": 0,
- "lng": 0
}, - "cutout": true,
- "fontIcon": {
- "color": "string",
- "fontFamily": "string",
- "text": "string"
}, - "halos": [
- {
- "color": "string",
- "radius": 0,
- "width": 0
}
], - "image": "string",
- "label": {
- "backgroundColor": "string",
- "bold": true,
- "center": true,
- "color": "string",
- "fontFamily": "string",
- "fontSize": 0,
- "text": "string"
}, - "shape": "string",
- "size": 0,
- "color": "string",
- "fade": true,
- "data": {
- "property1": { },
- "property2": { }
}, - "glyphs": [
- {
- "angle": 0,
- "blink": true,
- "border": {
- "color": "string"
}, - "color": "string",
- "fontIcon": {
- "color": "string",
- "fontFamily": "string",
- "text": "string"
}, - "image": "string",
- "label": {
- "bold": true,
- "color": "string",
- "fontFamily": "string",
- "text": "string"
}, - "position": "string",
- "radius": 0,
- "size": 0
}
]
}
}Get a list, graph, or count of the principals that can control this node.
| object_id required | string (object-id) The object id of the entity being operated on. |
| skip | integer >= 0 Default: 0 The number of entries to skip for pagination. Only available for |
| limit | integer >= 0 Default: 10 The number of entries to limit in the response. Only available for |
| type | string Default: "list" Enum: "list" "graph" "count" The type of return data requested. If no type is provided, query will default to |
| sort_by | string (sort-by) Sort by column. Can be used multiple times; prepend a hyphen for descending order. Columns available for sorting are dependent on the entity object kind. |
| Prefer | integer [ 0 .. 60 ] Default: 30 Prefer header, used to specify a custom timeout in seconds using the wait parameter as per RFC7240. The default timeout is 30 seconds and maximum timeout is 60 seconds |
{- "property1": {
- "border": {
- "color": "string",
- "lineStyle": "string",
- "width": 0
}, - "coordinates": {
- "lat": 0,
- "lng": 0
}, - "cutout": true,
- "fontIcon": {
- "color": "string",
- "fontFamily": "string",
- "text": "string"
}, - "halos": [
- {
- "color": "string",
- "radius": 0,
- "width": 0
}
], - "image": "string",
- "label": {
- "backgroundColor": "string",
- "bold": true,
- "center": true,
- "color": "string",
- "fontFamily": "string",
- "fontSize": 0,
- "text": "string"
}, - "shape": "string",
- "size": 0,
- "color": "string",
- "fade": true,
- "data": {
- "property1": { },
- "property2": { }
}, - "glyphs": [
- {
- "angle": 0,
- "blink": true,
- "border": {
- "color": "string"
}, - "color": "string",
- "fontIcon": {
- "color": "string",
- "fontFamily": "string",
- "text": "string"
}, - "image": "string",
- "label": {
- "bold": true,
- "color": "string",
- "fontFamily": "string",
- "text": "string"
}, - "position": "string",
- "radius": 0,
- "size": 0
}
]
}, - "property2": {
- "border": {
- "color": "string",
- "lineStyle": "string",
- "width": 0
}, - "coordinates": {
- "lat": 0,
- "lng": 0
}, - "cutout": true,
- "fontIcon": {
- "color": "string",
- "fontFamily": "string",
- "text": "string"
}, - "halos": [
- {
- "color": "string",
- "radius": 0,
- "width": 0
}
], - "image": "string",
- "label": {
- "backgroundColor": "string",
- "bold": true,
- "center": true,
- "color": "string",
- "fontFamily": "string",
- "fontSize": 0,
- "text": "string"
}, - "shape": "string",
- "size": 0,
- "color": "string",
- "fade": true,
- "data": {
- "property1": { },
- "property2": { }
}, - "glyphs": [
- {
- "angle": 0,
- "blink": true,
- "border": {
- "color": "string"
}, - "color": "string",
- "fontIcon": {
- "color": "string",
- "fontFamily": "string",
- "text": "string"
}, - "image": "string",
- "label": {
- "bold": true,
- "color": "string",
- "fontFamily": "string",
- "text": "string"
}, - "position": "string",
- "radius": 0,
- "size": 0
}
]
}
}Get info and counts for this computer node.
| object_id required | string (object-id) The object id of the entity being operated on. |
| counts | boolean Default: true Include counts of related entities. Default value is |
| Prefer | integer [ 0 .. 60 ] Default: 30 Prefer header, used to specify a custom timeout in seconds using the wait parameter as per RFC7240. The default timeout is 30 seconds and maximum timeout is 60 seconds |
{- "data": {
- "props": {
- "property1": { },
- "property2": { }
}, - "property1": 0,
- "property2": 0
}
}Get a list, graph, or count of the systems this computer has admin rights to.
| object_id required | string (object-id) The object id of the entity being operated on. |
| skip | integer >= 0 Default: 0 The number of entries to skip for pagination. Only available for |
| limit | integer >= 0 Default: 10 The number of entries to limit in the response. Only available for |
| type | string Default: "list" Enum: "list" "graph" "count" The type of return data requested. If no type is provided, query will default to |
| sort_by | string (sort-by) Sort by column. Can be used multiple times; prepend a hyphen for descending order. Columns available for sorting are dependent on the entity object kind. |
| Prefer | integer [ 0 .. 60 ] Default: 30 Prefer header, used to specify a custom timeout in seconds using the wait parameter as per RFC7240. The default timeout is 30 seconds and maximum timeout is 60 seconds |
{- "property1": {
- "border": {
- "color": "string",
- "lineStyle": "string",
- "width": 0
}, - "coordinates": {
- "lat": 0,
- "lng": 0
}, - "cutout": true,
- "fontIcon": {
- "color": "string",
- "fontFamily": "string",
- "text": "string"
}, - "halos": [
- {
- "color": "string",
- "radius": 0,
- "width": 0
}
], - "image": "string",
- "label": {
- "backgroundColor": "string",
- "bold": true,
- "center": true,
- "color": "string",
- "fontFamily": "string",
- "fontSize": 0,
- "text": "string"
}, - "shape": "string",
- "size": 0,
- "color": "string",
- "fade": true,
- "data": {
- "property1": { },
- "property2": { }
}, - "glyphs": [
- {
- "angle": 0,
- "blink": true,
- "border": {
- "color": "string"
}, - "color": "string",
- "fontIcon": {
- "color": "string",
- "fontFamily": "string",
- "text": "string"
}, - "image": "string",
- "label": {
- "bold": true,
- "color": "string",
- "fontFamily": "string",
- "text": "string"
}, - "position": "string",
- "radius": 0,
- "size": 0
}
]
}, - "property2": {
- "border": {
- "color": "string",
- "lineStyle": "string",
- "width": 0
}, - "coordinates": {
- "lat": 0,
- "lng": 0
}, - "cutout": true,
- "fontIcon": {
- "color": "string",
- "fontFamily": "string",
- "text": "string"
}, - "halos": [
- {
- "color": "string",
- "radius": 0,
- "width": 0
}
], - "image": "string",
- "label": {
- "backgroundColor": "string",
- "bold": true,
- "center": true,
- "color": "string",
- "fontFamily": "string",
- "fontSize": 0,
- "text": "string"
}, - "shape": "string",
- "size": 0,
- "color": "string",
- "fade": true,
- "data": {
- "property1": { },
- "property2": { }
}, - "glyphs": [
- {
- "angle": 0,
- "blink": true,
- "border": {
- "color": "string"
}, - "color": "string",
- "fontIcon": {
- "color": "string",
- "fontFamily": "string",
- "text": "string"
}, - "image": "string",
- "label": {
- "bold": true,
- "color": "string",
- "fontFamily": "string",
- "text": "string"
}, - "position": "string",
- "radius": 0,
- "size": 0
}
]
}
}Get a list, graph, or count of the principals that have admin rights on this computer.
| object_id required | string (object-id) The object id of the entity being operated on. |
| skip | integer >= 0 Default: 0 The number of entries to skip for pagination. Only available for |
| limit | integer >= 0 Default: 10 The number of entries to limit in the response. Only available for |
| type | string Default: "list" Enum: "list" "graph" "count" The type of return data requested. If no type is provided, query will default to |
| sort_by | string (sort-by) Sort by column. Can be used multiple times; prepend a hyphen for descending order. Columns available for sorting are dependent on the entity object kind. |
| Prefer | integer [ 0 .. 60 ] Default: 30 Prefer header, used to specify a custom timeout in seconds using the wait parameter as per RFC7240. The default timeout is 30 seconds and maximum timeout is 60 seconds |
{- "property1": {
- "border": {
- "color": "string",
- "lineStyle": "string",
- "width": 0
}, - "coordinates": {
- "lat": 0,
- "lng": 0
}, - "cutout": true,
- "fontIcon": {
- "color": "string",
- "fontFamily": "string",
- "text": "string"
}, - "halos": [
- {
- "color": "string",
- "radius": 0,
- "width": 0
}
], - "image": "string",
- "label": {
- "backgroundColor": "string",
- "bold": true,
- "center": true,
- "color": "string",
- "fontFamily": "string",
- "fontSize": 0,
- "text": "string"
}, - "shape": "string",
- "size": 0,
- "color": "string",
- "fade": true,
- "data": {
- "property1": { },
- "property2": { }
}, - "glyphs": [
- {
- "angle": 0,
- "blink": true,
- "border": {
- "color": "string"
}, - "color": "string",
- "fontIcon": {
- "color": "string",
- "fontFamily": "string",
- "text": "string"
}, - "image": "string",
- "label": {
- "bold": true,
- "color": "string",
- "fontFamily": "string",
- "text": "string"
}, - "position": "string",
- "radius": 0,
- "size": 0
}
]
}, - "property2": {
- "border": {
- "color": "string",
- "lineStyle": "string",
- "width": 0
}, - "coordinates": {
- "lat": 0,
- "lng": 0
}, - "cutout": true,
- "fontIcon": {
- "color": "string",
- "fontFamily": "string",
- "text": "string"
}, - "halos": [
- {
- "color": "string",
- "radius": 0,
- "width": 0
}
], - "image": "string",
- "label": {
- "backgroundColor": "string",
- "bold": true,
- "center": true,
- "color": "string",
- "fontFamily": "string",
- "fontSize": 0,
- "text": "string"
}, - "shape": "string",
- "size": 0,
- "color": "string",
- "fade": true,
- "data": {
- "property1": { },
- "property2": { }
}, - "glyphs": [
- {
- "angle": 0,
- "blink": true,
- "border": {
- "color": "string"
}, - "color": "string",
- "fontIcon": {
- "color": "string",
- "fontFamily": "string",
- "text": "string"
}, - "image": "string",
- "label": {
- "bold": true,
- "color": "string",
- "fontFamily": "string",
- "text": "string"
}, - "position": "string",
- "radius": 0,
- "size": 0
}
]
}
}Get a list, graph, or count of the principals that this computer has constrained delegations rights to.
| object_id required | string (object-id) The object id of the entity being operated on. |
| skip | integer >= 0 Default: 0 The number of entries to skip for pagination. Only available for |
| limit | integer >= 0 Default: 10 The number of entries to limit in the response. Only available for |
| type | string Default: "list" Enum: "list" "graph" "count" The type of return data requested. If no type is provided, query will default to |
| sort_by | string (sort-by) Sort by column. Can be used multiple times; prepend a hyphen for descending order. Columns available for sorting are dependent on the entity object kind. |
| Prefer | integer [ 0 .. 60 ] Default: 30 Prefer header, used to specify a custom timeout in seconds using the wait parameter as per RFC7240. The default timeout is 30 seconds and maximum timeout is 60 seconds |
{- "property1": {
- "border": {
- "color": "string",
- "lineStyle": "string",
- "width": 0
}, - "coordinates": {
- "lat": 0,
- "lng": 0
}, - "cutout": true,
- "fontIcon": {
- "color": "string",
- "fontFamily": "string",
- "text": "string"
}, - "halos": [
- {
- "color": "string",
- "radius": 0,
- "width": 0
}
], - "image": "string",
- "label": {
- "backgroundColor": "string",
- "bold": true,
- "center": true,
- "color": "string",
- "fontFamily": "string",
- "fontSize": 0,
- "text": "string"
}, - "shape": "string",
- "size": 0,
- "color": "string",
- "fade": true,
- "data": {
- "property1": { },
- "property2": { }
}, - "glyphs": [
- {
- "angle": 0,
- "blink": true,
- "border": {
- "color": "string"
}, - "color": "string",
- "fontIcon": {
- "color": "string",
- "fontFamily": "string",
- "text": "string"
}, - "image": "string",
- "label": {
- "bold": true,
- "color": "string",
- "fontFamily": "string",
- "text": "string"
}, - "position": "string",
- "radius": 0,
- "size": 0
}
]
}, - "property2": {
- "border": {
- "color": "string",
- "lineStyle": "string",
- "width": 0
}, - "coordinates": {
- "lat": 0,
- "lng": 0
}, - "cutout": true,
- "fontIcon": {
- "color": "string",
- "fontFamily": "string",
- "text": "string"
}, - "halos": [
- {
- "color": "string",
- "radius": 0,
- "width": 0
}
], - "image": "string",
- "label": {
- "backgroundColor": "string",
- "bold": true,
- "center": true,
- "color": "string",
- "fontFamily": "string",
- "fontSize": 0,
- "text": "string"
}, - "shape": "string",
- "size": 0,
- "color": "string",
- "fade": true,
- "data": {
- "property1": { },
- "property2": { }
}, - "glyphs": [
- {
- "angle": 0,
- "blink": true,
- "border": {
- "color": "string"
}, - "color": "string",
- "fontIcon": {
- "color": "string",
- "fontFamily": "string",
- "text": "string"
}, - "image": "string",
- "label": {
- "bold": true,
- "color": "string",
- "fontFamily": "string",
- "text": "string"
}, - "position": "string",
- "radius": 0,
- "size": 0
}
]
}
}Get a list, graph, or count of the principals that have constrained delegation rights to this computer.
| object_id required | string (object-id) The object id of the entity being operated on. |
| skip | integer >= 0 Default: 0 The number of entries to skip for pagination. Only available for |
| limit | integer >= 0 Default: 10 The number of entries to limit in the response. Only available for |
| type | string Default: "list" Enum: "list" "graph" "count" The type of return data requested. If no type is provided, query will default to |
| sort_by | string (sort-by) Sort by column. Can be used multiple times; prepend a hyphen for descending order. Columns available for sorting are dependent on the entity object kind. |
| Prefer | integer [ 0 .. 60 ] Default: 30 Prefer header, used to specify a custom timeout in seconds using the wait parameter as per RFC7240. The default timeout is 30 seconds and maximum timeout is 60 seconds |
{- "property1": {
- "border": {
- "color": "string",
- "lineStyle": "string",
- "width": 0
}, - "coordinates": {
- "lat": 0,
- "lng": 0
}, - "cutout": true,
- "fontIcon": {
- "color": "string",
- "fontFamily": "string",
- "text": "string"
}, - "halos": [
- {
- "color": "string",
- "radius": 0,
- "width": 0
}
], - "image": "string",
- "label": {
- "backgroundColor": "string",
- "bold": true,
- "center": true,
- "color": "string",
- "fontFamily": "string",
- "fontSize": 0,
- "text": "string"
}, - "shape": "string",
- "size": 0,
- "color": "string",
- "fade": true,
- "data": {
- "property1": { },
- "property2": { }
}, - "glyphs": [
- {
- "angle": 0,
- "blink": true,
- "border": {
- "color": "string"
}, - "color": "string",
- "fontIcon": {
- "color": "string",
- "fontFamily": "string",
- "text": "string"
}, - "image": "string",
- "label": {
- "bold": true,
- "color": "string",
- "fontFamily": "string",
- "text": "string"
}, - "position": "string",
- "radius": 0,
- "size": 0
}
]
}, - "property2": {
- "border": {
- "color": "string",
- "lineStyle": "string",
- "width": 0
}, - "coordinates": {
- "lat": 0,
- "lng": 0
}, - "cutout": true,
- "fontIcon": {
- "color": "string",
- "fontFamily": "string",
- "text": "string"
}, - "halos": [
- {
- "color": "string",
- "radius": 0,
- "width": 0
}
], - "image": "string",
- "label": {
- "backgroundColor": "string",
- "bold": true,
- "center": true,
- "color": "string",
- "fontFamily": "string",
- "fontSize": 0,
- "text": "string"
}, - "shape": "string",
- "size": 0,
- "color": "string",
- "fade": true,
- "data": {
- "property1": { },
- "property2": { }
}, - "glyphs": [
- {
- "angle": 0,
- "blink": true,
- "border": {
- "color": "string"
}, - "color": "string",
- "fontIcon": {
- "color": "string",
- "fontFamily": "string",
- "text": "string"
}, - "image": "string",
- "label": {
- "bold": true,
- "color": "string",
- "fontFamily": "string",
- "text": "string"
}, - "position": "string",
- "radius": 0,
- "size": 0
}
]
}
}Get a list, graph, or count of the principals this computer can control.
| object_id required | string (object-id) The object id of the entity being operated on. |
| skip | integer >= 0 Default: 0 The number of entries to skip for pagination. Only available for |
| limit | integer >= 0 Default: 10 The number of entries to limit in the response. Only available for |
| type | string Default: "list" Enum: "list" "graph" "count" The type of return data requested. If no type is provided, query will default to |
| sort_by | string (sort-by) Sort by column. Can be used multiple times; prepend a hyphen for descending order. Columns available for sorting are dependent on the entity object kind. |
| Prefer | integer [ 0 .. 60 ] Default: 30 Prefer header, used to specify a custom timeout in seconds using the wait parameter as per RFC7240. The default timeout is 30 seconds and maximum timeout is 60 seconds |
{- "property1": {
- "border": {
- "color": "string",
- "lineStyle": "string",
- "width": 0
}, - "coordinates": {
- "lat": 0,
- "lng": 0
}, - "cutout": true,
- "fontIcon": {
- "color": "string",
- "fontFamily": "string",
- "text": "string"
}, - "halos": [
- {
- "color": "string",
- "radius": 0,
- "width": 0
}
], - "image": "string",
- "label": {
- "backgroundColor": "string",
- "bold": true,
- "center": true,
- "color": "string",
- "fontFamily": "string",
- "fontSize": 0,
- "text": "string"
}, - "shape": "string",
- "size": 0,
- "color": "string",
- "fade": true,
- "data": {
- "property1": { },
- "property2": { }
}, - "glyphs": [
- {
- "angle": 0,
- "blink": true,
- "border": {
- "color": "string"
}, - "color": "string",
- "fontIcon": {
- "color": "string",
- "fontFamily": "string",
- "text": "string"
}, - "image": "string",
- "label": {
- "bold": true,
- "color": "string",
- "fontFamily": "string",
- "text": "string"
}, - "position": "string",
- "radius": 0,
- "size": 0
}
]
}, - "property2": {
- "border": {
- "color": "string",
- "lineStyle": "string",
- "width": 0
}, - "coordinates": {
- "lat": 0,
- "lng": 0
}, - "cutout": true,
- "fontIcon": {
- "color": "string",
- "fontFamily": "string",
- "text": "string"
}, - "halos": [
- {
- "color": "string",
- "radius": 0,
- "width": 0
}
], - "image": "string",
- "label": {
- "backgroundColor": "string",
- "bold": true,
- "center": true,
- "color": "string",
- "fontFamily": "string",
- "fontSize": 0,
- "text": "string"
}, - "shape": "string",
- "size": 0,
- "color": "string",
- "fade": true,
- "data": {
- "property1": { },
- "property2": { }
}, - "glyphs": [
- {
- "angle": 0,
- "blink": true,
- "border": {
- "color": "string"
}, - "color": "string",
- "fontIcon": {
- "color": "string",
- "fontFamily": "string",
- "text": "string"
}, - "image": "string",
- "label": {
- "bold": true,
- "color": "string",
- "fontFamily": "string",
- "text": "string"
}, - "position": "string",
- "radius": 0,
- "size": 0
}
]
}
}Get a list, graph, or count of the principals that can control this computer.
| object_id required | string (object-id) The object id of the entity being operated on. |
| skip | integer >= 0 Default: 0 The number of entries to skip for pagination. Only available for |
| limit | integer >= 0 Default: 10 The number of entries to limit in the response. Only available for |
| type | string Default: "list" Enum: "list" "graph" "count" The type of return data requested. If no type is provided, query will default to |
| sort_by | string (sort-by) Sort by column. Can be used multiple times; prepend a hyphen for descending order. Columns available for sorting are dependent on the entity object kind. |
| Prefer | integer [ 0 .. 60 ] Default: 30 Prefer header, used to specify a custom timeout in seconds using the wait parameter as per RFC7240. The default timeout is 30 seconds and maximum timeout is 60 seconds |
{- "property1": {
- "border": {
- "color": "string",
- "lineStyle": "string",
- "width": 0
}, - "coordinates": {
- "lat": 0,
- "lng": 0
}, - "cutout": true,
- "fontIcon": {
- "color": "string",
- "fontFamily": "string",
- "text": "string"
}, - "halos": [
- {
- "color": "string",
- "radius": 0,
- "width": 0
}
], - "image": "string",
- "label": {
- "backgroundColor": "string",
- "bold": true,
- "center": true,
- "color": "string",
- "fontFamily": "string",
- "fontSize": 0,
- "text": "string"
}, - "shape": "string",
- "size": 0,
- "color": "string",
- "fade": true,
- "data": {
- "property1": { },
- "property2": { }
}, - "glyphs": [
- {
- "angle": 0,
- "blink": true,
- "border": {
- "color": "string"
}, - "color": "string",
- "fontIcon": {
- "color": "string",
- "fontFamily": "string",
- "text": "string"
}, - "image": "string",
- "label": {
- "bold": true,
- "color": "string",
- "fontFamily": "string",
- "text": "string"
}, - "position": "string",
- "radius": 0,
- "size": 0
}
]
}, - "property2": {
- "border": {
- "color": "string",
- "lineStyle": "string",
- "width": 0
}, - "coordinates": {
- "lat": 0,
- "lng": 0
}, - "cutout": true,
- "fontIcon": {
- "color": "string",
- "fontFamily": "string",
- "text": "string"
}, - "halos": [
- {
- "color": "string",
- "radius": 0,
- "width": 0
}
], - "image": "string",
- "label": {
- "backgroundColor": "string",
- "bold": true,
- "center": true,
- "color": "string",
- "fontFamily": "string",
- "fontSize": 0,
- "text": "string"
}, - "shape": "string",
- "size": 0,
- "color": "string",
- "fade": true,
- "data": {
- "property1": { },
- "property2": { }
}, - "glyphs": [
- {
- "angle": 0,
- "blink": true,
- "border": {
- "color": "string"
}, - "color": "string",
- "fontIcon": {
- "color": "string",
- "fontFamily": "string",
- "text": "string"
}, - "image": "string",
- "label": {
- "bold": true,
- "color": "string",
- "fontFamily": "string",
- "text": "string"
}, - "position": "string",
- "radius": 0,
- "size": 0
}
]
}
}Get a list, graph, or count of the systems this computer can execute DCOM on.
| object_id required | string (object-id) The object id of the entity being operated on. |
| skip | integer >= 0 Default: 0 The number of entries to skip for pagination. Only available for |
| limit | integer >= 0 Default: 10 The number of entries to limit in the response. Only available for |
| type | string Default: "list" Enum: "list" "graph" "count" The type of return data requested. If no type is provided, query will default to |
| sort_by | string (sort-by) Sort by column. Can be used multiple times; prepend a hyphen for descending order. Columns available for sorting are dependent on the entity object kind. |
| Prefer | integer [ 0 .. 60 ] Default: 30 Prefer header, used to specify a custom timeout in seconds using the wait parameter as per RFC7240. The default timeout is 30 seconds and maximum timeout is 60 seconds |
{- "property1": {
- "border": {
- "color": "string",
- "lineStyle": "string",
- "width": 0
}, - "coordinates": {
- "lat": 0,
- "lng": 0
}, - "cutout": true,
- "fontIcon": {
- "color": "string",
- "fontFamily": "string",
- "text": "string"
}, - "halos": [
- {
- "color": "string",
- "radius": 0,
- "width": 0
}
], - "image": "string",
- "label": {
- "backgroundColor": "string",
- "bold": true,
- "center": true,
- "color": "string",
- "fontFamily": "string",
- "fontSize": 0,
- "text": "string"
}, - "shape": "string",
- "size": 0,
- "color": "string",
- "fade": true,
- "data": {
- "property1": { },
- "property2": { }
}, - "glyphs": [
- {
- "angle": 0,
- "blink": true,
- "border": {
- "color": "string"
}, - "color": "string",
- "fontIcon": {
- "color": "string",
- "fontFamily": "string",
- "text": "string"
}, - "image": "string",
- "label": {
- "bold": true,
- "color": "string",
- "fontFamily": "string",
- "text": "string"
}, - "position": "string",
- "radius": 0,
- "size": 0
}
]
}, - "property2": {
- "border": {
- "color": "string",
- "lineStyle": "string",
- "width": 0
}, - "coordinates": {
- "lat": 0,
- "lng": 0
}, - "cutout": true,
- "fontIcon": {
- "color": "string",
- "fontFamily": "string",
- "text": "string"
}, - "halos": [
- {
- "color": "string",
- "radius": 0,
- "width": 0
}
], - "image": "string",
- "label": {
- "backgroundColor": "string",
- "bold": true,
- "center": true,
- "color": "string",
- "fontFamily": "string",
- "fontSize": 0,
- "text": "string"
}, - "shape": "string",
- "size": 0,
- "color": "string",
- "fade": true,
- "data": {
- "property1": { },
- "property2": { }
}, - "glyphs": [
- {
- "angle": 0,
- "blink": true,
- "border": {
- "color": "string"
}, - "color": "string",
- "fontIcon": {
- "color": "string",
- "fontFamily": "string",
- "text": "string"
}, - "image": "string",
- "label": {
- "bold": true,
- "color": "string",
- "fontFamily": "string",
- "text": "string"
}, - "position": "string",
- "radius": 0,
- "size": 0
}
]
}
}Get a list, graph, or count of the principals that can execute DCOM on this computer.
| object_id required | string (object-id) The object id of the entity being operated on. |
| skip | integer >= 0 Default: 0 The number of entries to skip for pagination. Only available for |
| limit | integer >= 0 Default: 10 The number of entries to limit in the response. Only available for |
| type | string Default: "list" Enum: "list" "graph" "count" The type of return data requested. If no type is provided, query will default to |
| sort_by | string (sort-by) Sort by column. Can be used multiple times; prepend a hyphen for descending order. Columns available for sorting are dependent on the entity object kind. |
| Prefer | integer [ 0 .. 60 ] Default: 30 Prefer header, used to specify a custom timeout in seconds using the wait parameter as per RFC7240. The default timeout is 30 seconds and maximum timeout is 60 seconds |
{- "property1": {
- "border": {
- "color": "string",
- "lineStyle": "string",
- "width": 0
}, - "coordinates": {
- "lat": 0,
- "lng": 0
}, - "cutout": true,
- "fontIcon": {
- "color": "string",
- "fontFamily": "string",
- "text": "string"
}, - "halos": [
- {
- "color": "string",
- "radius": 0,
- "width": 0
}
], - "image": "string",
- "label": {
- "backgroundColor": "string",
- "bold": true,
- "center": true,
- "color": "string",
- "fontFamily": "string",
- "fontSize": 0,
- "text": "string"
}, - "shape": "string",
- "size": 0,
- "color": "string",
- "fade": true,
- "data": {
- "property1": { },
- "property2": { }
}, - "glyphs": [
- {
- "angle": 0,
- "blink": true,
- "border": {
- "color": "string"
}, - "color": "string",
- "fontIcon": {
- "color": "string",
- "fontFamily": "string",
- "text": "string"
}, - "image": "string",
- "label": {
- "bold": true,
- "color": "string",
- "fontFamily": "string",
- "text": "string"
}, - "position": "string",
- "radius": 0,
- "size": 0
}
]
}, - "property2": {
- "border": {
- "color": "string",
- "lineStyle": "string",
- "width": 0
}, - "coordinates": {
- "lat": 0,
- "lng": 0
}, - "cutout": true,
- "fontIcon": {
- "color": "string",
- "fontFamily": "string",
- "text": "string"
}, - "halos": [
- {
- "color": "string",
- "radius": 0,
- "width": 0
}
], - "image": "string",
- "label": {
- "backgroundColor": "string",
- "bold": true,
- "center": true,
- "color": "string",
- "fontFamily": "string",
- "fontSize": 0,
- "text": "string"
}, - "shape": "string",
- "size": 0,
- "color": "string",
- "fade": true,
- "data": {
- "property1": { },
- "property2": { }
}, - "glyphs": [
- {
- "angle": 0,
- "blink": true,
- "border": {
- "color": "string"
}, - "color": "string",
- "fontIcon": {
- "color": "string",
- "fontFamily": "string",
- "text": "string"
}, - "image": "string",
- "label": {
- "bold": true,
- "color": "string",
- "fontFamily": "string",
- "text": "string"
}, - "position": "string",
- "radius": 0,
- "size": 0
}
]
}
}Get a list, graph, or count of the groups this computer is a member of.
| object_id required | string (object-id) The object id of the entity being operated on. |
| skip | integer >= 0 Default: 0 The number of entries to skip for pagination. Only available for |
| limit | integer >= 0 Default: 10 The number of entries to limit in the response. Only available for |
| type | string Default: "list" Enum: "list" "graph" "count" The type of return data requested. If no type is provided, query will default to |
| sort_by | string (sort-by) Sort by column. Can be used multiple times; prepend a hyphen for descending order. Columns available for sorting are dependent on the entity object kind. |
| Prefer | integer [ 0 .. 60 ] Default: 30 Prefer header, used to specify a custom timeout in seconds using the wait parameter as per RFC7240. The default timeout is 30 seconds and maximum timeout is 60 seconds |
{- "property1": {
- "border": {
- "color": "string",
- "lineStyle": "string",
- "width": 0
}, - "coordinates": {
- "lat": 0,
- "lng": 0
}, - "cutout": true,
- "fontIcon": {
- "color": "string",
- "fontFamily": "string",
- "text": "string"
}, - "halos": [
- {
- "color": "string",
- "radius": 0,
- "width": 0
}
], - "image": "string",
- "label": {
- "backgroundColor": "string",
- "bold": true,
- "center": true,
- "color": "string",
- "fontFamily": "string",
- "fontSize": 0,
- "text": "string"
}, - "shape": "string",
- "size": 0,
- "color": "string",
- "fade": true,
- "data": {
- "property1": { },
- "property2": { }
}, - "glyphs": [
- {
- "angle": 0,
- "blink": true,
- "border": {
- "color": "string"
}, - "color": "string",
- "fontIcon": {
- "color": "string",
- "fontFamily": "string",
- "text": "string"
}, - "image": "string",
- "label": {
- "bold": true,
- "color": "string",
- "fontFamily": "string",
- "text": "string"
}, - "position": "string",
- "radius": 0,
- "size": 0
}
]
}, - "property2": {
- "border": {
- "color": "string",
- "lineStyle": "string",
- "width": 0
}, - "coordinates": {
- "lat": 0,
- "lng": 0
}, - "cutout": true,
- "fontIcon": {
- "color": "string",
- "fontFamily": "string",
- "text": "string"
}, - "halos": [
- {
- "color": "string",
- "radius": 0,
- "width": 0
}
], - "image": "string",
- "label": {
- "backgroundColor": "string",
- "bold": true,
- "center": true,
- "color": "string",
- "fontFamily": "string",
- "fontSize": 0,
- "text": "string"
}, - "shape": "string",
- "size": 0,
- "color": "string",
- "fade": true,
- "data": {
- "property1": { },
- "property2": { }
}, - "glyphs": [
- {
- "angle": 0,
- "blink": true,
- "border": {
- "color": "string"
}, - "color": "string",
- "fontIcon": {
- "color": "string",
- "fontFamily": "string",
- "text": "string"
}, - "image": "string",
- "label": {
- "bold": true,
- "color": "string",
- "fontFamily": "string",
- "text": "string"
}, - "position": "string",
- "radius": 0,
- "size": 0
}
]
}
}Get a list, graph, or count of the systems this computer has remote PowerShell rights on.
| object_id required | string (object-id) The object id of the entity being operated on. |
| skip | integer >= 0 Default: 0 The number of entries to skip for pagination. Only available for |
| limit | integer >= 0 Default: 10 The number of entries to limit in the response. Only available for |
| type | string Default: "list" Enum: "list" "graph" "count" The type of return data requested. If no type is provided, query will default to |
| sort_by | string (sort-by) Sort by column. Can be used multiple times; prepend a hyphen for descending order. Columns available for sorting are dependent on the entity object kind. |
| Prefer | integer [ 0 .. 60 ] Default: 30 Prefer header, used to specify a custom timeout in seconds using the wait parameter as per RFC7240. The default timeout is 30 seconds and maximum timeout is 60 seconds |
{- "property1": {
- "border": {
- "color": "string",
- "lineStyle": "string",
- "width": 0
}, - "coordinates": {
- "lat": 0,
- "lng": 0
}, - "cutout": true,
- "fontIcon": {
- "color": "string",
- "fontFamily": "string",
- "text": "string"
}, - "halos": [
- {
- "color": "string",
- "radius": 0,
- "width": 0
}
], - "image": "string",
- "label": {
- "backgroundColor": "string",
- "bold": true,
- "center": true,
- "color": "string",
- "fontFamily": "string",
- "fontSize": 0,
- "text": "string"
}, - "shape": "string",
- "size": 0,
- "color": "string",
- "fade": true,
- "data": {
- "property1": { },
- "property2": { }
}, - "glyphs": [
- {
- "angle": 0,
- "blink": true,
- "border": {
- "color": "string"
}, - "color": "string",
- "fontIcon": {
- "color": "string",
- "fontFamily": "string",
- "text": "string"
}, - "image": "string",
- "label": {
- "bold": true,
- "color": "string",
- "fontFamily": "string",
- "text": "string"
}, - "position": "string",
- "radius": 0,
- "size": 0
}
]
}, - "property2": {
- "border": {
- "color": "string",
- "lineStyle": "string",
- "width": 0
}, - "coordinates": {
- "lat": 0,
- "lng": 0
}, - "cutout": true,
- "fontIcon": {
- "color": "string",
- "fontFamily": "string",
- "text": "string"
}, - "halos": [
- {
- "color": "string",
- "radius": 0,
- "width": 0
}
], - "image": "string",
- "label": {
- "backgroundColor": "string",
- "bold": true,
- "center": true,
- "color": "string",
- "fontFamily": "string",
- "fontSize": 0,
- "text": "string"
}, - "shape": "string",
- "size": 0,
- "color": "string",
- "fade": true,
- "data": {
- "property1": { },
- "property2": { }
}, - "glyphs": [
- {
- "angle": 0,
- "blink": true,
- "border": {
- "color": "string"
}, - "color": "string",
- "fontIcon": {
- "color": "string",
- "fontFamily": "string",
- "text": "string"
}, - "image": "string",
- "label": {
- "bold": true,
- "color": "string",
- "fontFamily": "string",
- "text": "string"
}, - "position": "string",
- "radius": 0,
- "size": 0
}
]
}
}Get a list, graph, or count of the principals that have remote PowerShell rights on this computer.
| object_id required | string (object-id) The object id of the entity being operated on. |
| skip | integer >= 0 Default: 0 The number of entries to skip for pagination. Only available for |
| limit | integer >= 0 Default: 10 The number of entries to limit in the response. Only available for |
| type | string Default: "list" Enum: "list" "graph" "count" The type of return data requested. If no type is provided, query will default to |
| sort_by | string (sort-by) Sort by column. Can be used multiple times; prepend a hyphen for descending order. Columns available for sorting are dependent on the entity object kind. |
| Prefer | integer [ 0 .. 60 ] Default: 30 Prefer header, used to specify a custom timeout in seconds using the wait parameter as per RFC7240. The default timeout is 30 seconds and maximum timeout is 60 seconds |
{- "property1": {
- "border": {
- "color": "string",
- "lineStyle": "string",
- "width": 0
}, - "coordinates": {
- "lat": 0,
- "lng": 0
}, - "cutout": true,
- "fontIcon": {
- "color": "string",
- "fontFamily": "string",
- "text": "string"
}, - "halos": [
- {
- "color": "string",
- "radius": 0,
- "width": 0
}
], - "image": "string",
- "label": {
- "backgroundColor": "string",
- "bold": true,
- "center": true,
- "color": "string",
- "fontFamily": "string",
- "fontSize": 0,
- "text": "string"
}, - "shape": "string",
- "size": 0,
- "color": "string",
- "fade": true,
- "data": {
- "property1": { },
- "property2": { }
}, - "glyphs": [
- {
- "angle": 0,
- "blink": true,
- "border": {
- "color": "string"
}, - "color": "string",
- "fontIcon": {
- "color": "string",
- "fontFamily": "string",
- "text": "string"
}, - "image": "string",
- "label": {
- "bold": true,
- "color": "string",
- "fontFamily": "string",
- "text": "string"
}, - "position": "string",
- "radius": 0,
- "size": 0
}
]
}, - "property2": {
- "border": {
- "color": "string",
- "lineStyle": "string",
- "width": 0
}, - "coordinates": {
- "lat": 0,
- "lng": 0
}, - "cutout": true,
- "fontIcon": {
- "color": "string",
- "fontFamily": "string",
- "text": "string"
}, - "halos": [
- {
- "color": "string",
- "radius": 0,
- "width": 0
}
], - "image": "string",
- "label": {
- "backgroundColor": "string",
- "bold": true,
- "center": true,
- "color": "string",
- "fontFamily": "string",
- "fontSize": 0,
- "text": "string"
}, - "shape": "string",
- "size": 0,
- "color": "string",
- "fade": true,
- "data": {
- "property1": { },
- "property2": { }
}, - "glyphs": [
- {
- "angle": 0,
- "blink": true,
- "border": {
- "color": "string"
}, - "color": "string",
- "fontIcon": {
- "color": "string",
- "fontFamily": "string",
- "text": "string"
}, - "image": "string",
- "label": {
- "bold": true,
- "color": "string",
- "fontFamily": "string",
- "text": "string"
}, - "position": "string",
- "radius": 0,
- "size": 0
}
]
}
}Get a list, graph, or count of the systems this computer can RDP to.
| object_id required | string (object-id) The object id of the entity being operated on. |
| skip | integer >= 0 Default: 0 The number of entries to skip for pagination. Only available for |
| limit | integer >= 0 Default: 10 The number of entries to limit in the response. Only available for |
| type | string Default: "list" Enum: "list" "graph" "count" The type of return data requested. If no type is provided, query will default to |
| sort_by | string (sort-by) Sort by column. Can be used multiple times; prepend a hyphen for descending order. Columns available for sorting are dependent on the entity object kind. |
| Prefer | integer [ 0 .. 60 ] Default: 30 Prefer header, used to specify a custom timeout in seconds using the wait parameter as per RFC7240. The default timeout is 30 seconds and maximum timeout is 60 seconds |
{- "property1": {
- "border": {
- "color": "string",
- "lineStyle": "string",
- "width": 0
}, - "coordinates": {
- "lat": 0,
- "lng": 0
}, - "cutout": true,
- "fontIcon": {
- "color": "string",
- "fontFamily": "string",
- "text": "string"
}, - "halos": [
- {
- "color": "string",
- "radius": 0,
- "width": 0
}
], - "image": "string",
- "label": {
- "backgroundColor": "string",
- "bold": true,
- "center": true,
- "color": "string",
- "fontFamily": "string",
- "fontSize": 0,
- "text": "string"
}, - "shape": "string",
- "size": 0,
- "color": "string",
- "fade": true,
- "data": {
- "property1": { },
- "property2": { }
}, - "glyphs": [
- {
- "angle": 0,
- "blink": true,
- "border": {
- "color": "string"
}, - "color": "string",
- "fontIcon": {
- "color": "string",
- "fontFamily": "string",
- "text": "string"
}, - "image": "string",
- "label": {
- "bold": true,
- "color": "string",
- "fontFamily": "string",
- "text": "string"
}, - "position": "string",
- "radius": 0,
- "size": 0
}
]
}, - "property2": {
- "border": {
- "color": "string",
- "lineStyle": "string",
- "width": 0
}, - "coordinates": {
- "lat": 0,
- "lng": 0
}, - "cutout": true,
- "fontIcon": {
- "color": "string",
- "fontFamily": "string",
- "text": "string"
}, - "halos": [
- {
- "color": "string",
- "radius": 0,
- "width": 0
}
], - "image": "string",
- "label": {
- "backgroundColor": "string",
- "bold": true,
- "center": true,
- "color": "string",
- "fontFamily": "string",
- "fontSize": 0,
- "text": "string"
}, - "shape": "string",
- "size": 0,
- "color": "string",
- "fade": true,
- "data": {
- "property1": { },
- "property2": { }
}, - "glyphs": [
- {
- "angle": 0,
- "blink": true,
- "border": {
- "color": "string"
}, - "color": "string",
- "fontIcon": {
- "color": "string",
- "fontFamily": "string",
- "text": "string"
}, - "image": "string",
- "label": {
- "bold": true,
- "color": "string",
- "fontFamily": "string",
- "text": "string"
}, - "position": "string",
- "radius": 0,
- "size": 0
}
]
}
}Get a list, graph, or count of the principals that have RDP rights on this computer.
| object_id required | string (object-id) The object id of the entity being operated on. |
| skip | integer >= 0 Default: 0 The number of entries to skip for pagination. Only available for |
| limit | integer >= 0 Default: 10 The number of entries to limit in the response. Only available for |
| type | string Default: "list" Enum: "list" "graph" "count" The type of return data requested. If no type is provided, query will default to |
| sort_by | string (sort-by) Sort by column. Can be used multiple times; prepend a hyphen for descending order. Columns available for sorting are dependent on the entity object kind. |
| Prefer | integer [ 0 .. 60 ] Default: 30 Prefer header, used to specify a custom timeout in seconds using the wait parameter as per RFC7240. The default timeout is 30 seconds and maximum timeout is 60 seconds |
{- "property1": {
- "border": {
- "color": "string",
- "lineStyle": "string",
- "width": 0
}, - "coordinates": {
- "lat": 0,
- "lng": 0
}, - "cutout": true,
- "fontIcon": {
- "color": "string",
- "fontFamily": "string",
- "text": "string"
}, - "halos": [
- {
- "color": "string",
- "radius": 0,
- "width": 0
}
], - "image": "string",
- "label": {
- "backgroundColor": "string",
- "bold": true,
- "center": true,
- "color": "string",
- "fontFamily": "string",
- "fontSize": 0,
- "text": "string"
}, - "shape": "string",
- "size": 0,
- "color": "string",
- "fade": true,
- "data": {
- "property1": { },
- "property2": { }
}, - "glyphs": [
- {
- "angle": 0,
- "blink": true,
- "border": {
- "color": "string"
}, - "color": "string",
- "fontIcon": {
- "color": "string",
- "fontFamily": "string",
- "text": "string"
}, - "image": "string",
- "label": {
- "bold": true,
- "color": "string",
- "fontFamily": "string",
- "text": "string"
}, - "position": "string",
- "radius": 0,
- "size": 0
}
]
}, - "property2": {
- "border": {
- "color": "string",
- "lineStyle": "string",
- "width": 0
}, - "coordinates": {
- "lat": 0,
- "lng": 0
}, - "cutout": true,
- "fontIcon": {
- "color": "string",
- "fontFamily": "string",
- "text": "string"
}, - "halos": [
- {
- "color": "string",
- "radius": 0,
- "width": 0
}
], - "image": "string",
- "label": {
- "backgroundColor": "string",
- "bold": true,
- "center": true,
- "color": "string",
- "fontFamily": "string",
- "fontSize": 0,
- "text": "string"
}, - "shape": "string",
- "size": 0,
- "color": "string",
- "fade": true,
- "data": {
- "property1": { },
- "property2": { }
}, - "glyphs": [
- {
- "angle": 0,
- "blink": true,
- "border": {
- "color": "string"
}, - "color": "string",
- "fontIcon": {
- "color": "string",
- "fontFamily": "string",
- "text": "string"
}, - "image": "string",
- "label": {
- "bold": true,
- "color": "string",
- "fontFamily": "string",
- "text": "string"
}, - "position": "string",
- "radius": 0,
- "size": 0
}
]
}
}Get a list, graph, or count of the principals with active sessions on this computer.
| object_id required | string (object-id) The object id of the entity being operated on. |
| skip | integer >= 0 Default: 0 The number of entries to skip for pagination. Only available for |
| limit | integer >= 0 Default: 10 The number of entries to limit in the response. Only available for |
| type | string Default: "list" Enum: "list" "graph" "count" The type of return data requested. If no type is provided, query will default to |
| sort_by | string (sort-by) Sort by column. Can be used multiple times; prepend a hyphen for descending order. Columns available for sorting are dependent on the entity object kind. |
| Prefer | integer [ 0 .. 60 ] Default: 30 Prefer header, used to specify a custom timeout in seconds using the wait parameter as per RFC7240. The default timeout is 30 seconds and maximum timeout is 60 seconds |
{- "property1": {
- "border": {
- "color": "string",
- "lineStyle": "string",
- "width": 0
}, - "coordinates": {
- "lat": 0,
- "lng": 0
}, - "cutout": true,
- "fontIcon": {
- "color": "string",
- "fontFamily": "string",
- "text": "string"
}, - "halos": [
- {
- "color": "string",
- "radius": 0,
- "width": 0
}
], - "image": "string",
- "label": {
- "backgroundColor": "string",
- "bold": true,
- "center": true,
- "color": "string",
- "fontFamily": "string",
- "fontSize": 0,
- "text": "string"
}, - "shape": "string",
- "size": 0,
- "color": "string",
- "fade": true,
- "data": {
- "property1": { },
- "property2": { }
}, - "glyphs": [
- {
- "angle": 0,
- "blink": true,
- "border": {
- "color": "string"
}, - "color": "string",
- "fontIcon": {
- "color": "string",
- "fontFamily": "string",
- "text": "string"
}, - "image": "string",
- "label": {
- "bold": true,
- "color": "string",
- "fontFamily": "string",
- "text": "string"
}, - "position": "string",
- "radius": 0,
- "size": 0
}
]
}, - "property2": {
- "border": {
- "color": "string",
- "lineStyle": "string",
- "width": 0
}, - "coordinates": {
- "lat": 0,
- "lng": 0
}, - "cutout": true,
- "fontIcon": {
- "color": "string",
- "fontFamily": "string",
- "text": "string"
}, - "halos": [
- {
- "color": "string",
- "radius": 0,
- "width": 0
}
], - "image": "string",
- "label": {
- "backgroundColor": "string",
- "bold": true,
- "center": true,
- "color": "string",
- "fontFamily": "string",
- "fontSize": 0,
- "text": "string"
}, - "shape": "string",
- "size": 0,
- "color": "string",
- "fade": true,
- "data": {
- "property1": { },
- "property2": { }
}, - "glyphs": [
- {
- "angle": 0,
- "blink": true,
- "border": {
- "color": "string"
}, - "color": "string",
- "fontIcon": {
- "color": "string",
- "fontFamily": "string",
- "text": "string"
}, - "image": "string",
- "label": {
- "bold": true,
- "color": "string",
- "fontFamily": "string",
- "text": "string"
}, - "position": "string",
- "radius": 0,
- "size": 0
}
]
}
}Get a list, graph, or count of the principals that have SQL admin rights on this computer.
| object_id required | string (object-id) The object id of the entity being operated on. |
| skip | integer >= 0 Default: 0 The number of entries to skip for pagination. Only available for |
| limit | integer >= 0 Default: 10 The number of entries to limit in the response. Only available for |
| type | string Default: "list" Enum: "list" "graph" "count" The type of return data requested. If no type is provided, query will default to |
| sort_by | string (sort-by) Sort by column. Can be used multiple times; prepend a hyphen for descending order. Columns available for sorting are dependent on the entity object kind. |
| Prefer | integer [ 0 .. 60 ] Default: 30 Prefer header, used to specify a custom timeout in seconds using the wait parameter as per RFC7240. The default timeout is 30 seconds and maximum timeout is 60 seconds |
{- "property1": {
- "border": {
- "color": "string",
- "lineStyle": "string",
- "width": 0
}, - "coordinates": {
- "lat": 0,
- "lng": 0
}, - "cutout": true,
- "fontIcon": {
- "color": "string",
- "fontFamily": "string",
- "text": "string"
}, - "halos": [
- {
- "color": "string",
- "radius": 0,
- "width": 0
}
], - "image": "string",
- "label": {
- "backgroundColor": "string",
- "bold": true,
- "center": true,
- "color": "string",
- "fontFamily": "string",
- "fontSize": 0,
- "text": "string"
}, - "shape": "string",
- "size": 0,
- "color": "string",
- "fade": true,
- "data": {
- "property1": { },
- "property2": { }
}, - "glyphs": [
- {
- "angle": 0,
- "blink": true,
- "border": {
- "color": "string"
}, - "color": "string",
- "fontIcon": {
- "color": "string",
- "fontFamily": "string",
- "text": "string"
}, - "image": "string",
- "label": {
- "bold": true,
- "color": "string",
- "fontFamily": "string",
- "text": "string"
}, - "position": "string",
- "radius": 0,
- "size": 0
}
]
}, - "property2": {
- "border": {
- "color": "string",
- "lineStyle": "string",
- "width": 0
}, - "coordinates": {
- "lat": 0,
- "lng": 0
}, - "cutout": true,
- "fontIcon": {
- "color": "string",
- "fontFamily": "string",
- "text": "string"
}, - "halos": [
- {
- "color": "string",
- "radius": 0,
- "width": 0
}
], - "image": "string",
- "label": {
- "backgroundColor": "string",
- "bold": true,
- "center": true,
- "color": "string",
- "fontFamily": "string",
- "fontSize": 0,
- "text": "string"
}, - "shape": "string",
- "size": 0,
- "color": "string",
- "fade": true,
- "data": {
- "property1": { },
- "property2": { }
}, - "glyphs": [
- {
- "angle": 0,
- "blink": true,
- "border": {
- "color": "string"
}, - "color": "string",
- "fontIcon": {
- "color": "string",
- "fontFamily": "string",
- "text": "string"
}, - "image": "string",
- "label": {
- "bold": true,
- "color": "string",
- "fontFamily": "string",
- "text": "string"
}, - "position": "string",
- "radius": 0,
- "size": 0
}
]
}
}Get basic info and counts for this container node.
| object_id required | string (object-id) The object id of the entity being operated on. |
| counts | boolean Default: true Include counts of related entities. Default value is |
| Prefer | integer [ 0 .. 60 ] Default: 30 Prefer header, used to specify a custom timeout in seconds using the wait parameter as per RFC7240. The default timeout is 30 seconds and maximum timeout is 60 seconds |
{- "data": {
- "props": {
- "property1": { },
- "property2": { }
}, - "property1": 0,
- "property2": 0
}
}Get a list, graph, or count of the principals that can control this container.
| object_id required | string (object-id) The object id of the entity being operated on. |
| skip | integer >= 0 Default: 0 The number of entries to skip for pagination. Only available for |
| limit | integer >= 0 Default: 10 The number of entries to limit in the response. Only available for |
| type | string Default: "list" Enum: "list" "graph" "count" The type of return data requested. If no type is provided, query will default to |
| sort_by | string (sort-by) Sort by column. Can be used multiple times; prepend a hyphen for descending order. Columns available for sorting are dependent on the entity object kind. |
| Prefer | integer [ 0 .. 60 ] Default: 30 Prefer header, used to specify a custom timeout in seconds using the wait parameter as per RFC7240. The default timeout is 30 seconds and maximum timeout is 60 seconds |
{- "property1": {
- "border": {
- "color": "string",
- "lineStyle": "string",
- "width": 0
}, - "coordinates": {
- "lat": 0,
- "lng": 0
}, - "cutout": true,
- "fontIcon": {
- "color": "string",
- "fontFamily": "string",
- "text": "string"
}, - "halos": [
- {
- "color": "string",
- "radius": 0,
- "width": 0
}
], - "image": "string",
- "label": {
- "backgroundColor": "string",
- "bold": true,
- "center": true,
- "color": "string",
- "fontFamily": "string",
- "fontSize": 0,
- "text": "string"
}, - "shape": "string",
- "size": 0,
- "color": "string",
- "fade": true,
- "data": {
- "property1": { },
- "property2": { }
}, - "glyphs": [
- {
- "angle": 0,
- "blink": true,
- "border": {
- "color": "string"
}, - "color": "string",
- "fontIcon": {
- "color": "string",
- "fontFamily": "string",
- "text": "string"
}, - "image": "string",
- "label": {
- "bold": true,
- "color": "string",
- "fontFamily": "string",
- "text": "string"
}, - "position": "string",
- "radius": 0,
- "size": 0
}
]
}, - "property2": {
- "border": {
- "color": "string",
- "lineStyle": "string",
- "width": 0
}, - "coordinates": {
- "lat": 0,
- "lng": 0
}, - "cutout": true,
- "fontIcon": {
- "color": "string",
- "fontFamily": "string",
- "text": "string"
}, - "halos": [
- {
- "color": "string",
- "radius": 0,
- "width": 0
}
], - "image": "string",
- "label": {
- "backgroundColor": "string",
- "bold": true,
- "center": true,
- "color": "string",
- "fontFamily": "string",
- "fontSize": 0,
- "text": "string"
}, - "shape": "string",
- "size": 0,
- "color": "string",
- "fade": true,
- "data": {
- "property1": { },
- "property2": { }
}, - "glyphs": [
- {
- "angle": 0,
- "blink": true,
- "border": {
- "color": "string"
}, - "color": "string",
- "fontIcon": {
- "color": "string",
- "fontFamily": "string",
- "text": "string"
}, - "image": "string",
- "label": {
- "bold": true,
- "color": "string",
- "fontFamily": "string",
- "text": "string"
}, - "position": "string",
- "radius": 0,
- "size": 0
}
]
}
}Get basic info and counts for this domain node.
| object_id required | string (object-id) The object id of the entity being operated on. |
| counts | boolean Default: true Include counts of related entities. Default value is |
| Prefer | integer [ 0 .. 60 ] Default: 30 Prefer header, used to specify a custom timeout in seconds using the wait parameter as per RFC7240. The default timeout is 30 seconds and maximum timeout is 60 seconds |
{- "data": {
- "props": {
- "property1": { },
- "property2": { }
}, - "property1": 0,
- "property2": 0
}
}Updates the supported properties on the Domain entity.
| object_id required | string (object-id) The object id of the entity being operated on. |
| Prefer | integer [ 0 .. 60 ] Default: 30 Prefer header, used to specify a custom timeout in seconds using the wait parameter as per RFC7240. The default timeout is 30 seconds and maximum timeout is 60 seconds |
The patch request body for updating Domain
| collected | boolean |
{- "collected": true
}{- "data": {
- "collected": true
}
}Get a list or count of the computers that belong to this domain.
| object_id required | string (object-id) The object id of the entity being operated on. |
| skip | integer >= 0 Default: 0 The number of entries to skip for pagination. Only available for |
| limit | integer >= 0 Default: 10 The number of entries to limit in the response. Only available for |
| type | string Default: "list" Enum: "list" "graph" "count" The type of return data requested. If no type is provided, query will default to |
| sort_by | string (sort-by) Sort by column. Can be used multiple times; prepend a hyphen for descending order. Columns available for sorting are dependent on the entity object kind. |
| Prefer | integer [ 0 .. 60 ] Default: 30 Prefer header, used to specify a custom timeout in seconds using the wait parameter as per RFC7240. The default timeout is 30 seconds and maximum timeout is 60 seconds |
{- "property1": {
- "border": {
- "color": "string",
- "lineStyle": "string",
- "width": 0
}, - "coordinates": {
- "lat": 0,
- "lng": 0
}, - "cutout": true,
- "fontIcon": {
- "color": "string",
- "fontFamily": "string",
- "text": "string"
}, - "halos": [
- {
- "color": "string",
- "radius": 0,
- "width": 0
}
], - "image": "string",
- "label": {
- "backgroundColor": "string",
- "bold": true,
- "center": true,
- "color": "string",
- "fontFamily": "string",
- "fontSize": 0,
- "text": "string"
}, - "shape": "string",
- "size": 0,
- "color": "string",
- "fade": true,
- "data": {
- "property1": { },
- "property2": { }
}, - "glyphs": [
- {
- "angle": 0,
- "blink": true,
- "border": {
- "color": "string"
}, - "color": "string",
- "fontIcon": {
- "color": "string",
- "fontFamily": "string",
- "text": "string"
}, - "image": "string",
- "label": {
- "bold": true,
- "color": "string",
- "fontFamily": "string",
- "text": "string"
}, - "position": "string",
- "radius": 0,
- "size": 0
}
]
}, - "property2": {
- "border": {
- "color": "string",
- "lineStyle": "string",
- "width": 0
}, - "coordinates": {
- "lat": 0,
- "lng": 0
}, - "cutout": true,
- "fontIcon": {
- "color": "string",
- "fontFamily": "string",
- "text": "string"
}, - "halos": [
- {
- "color": "string",
- "radius": 0,
- "width": 0
}
], - "image": "string",
- "label": {
- "backgroundColor": "string",
- "bold": true,
- "center": true,
- "color": "string",
- "fontFamily": "string",
- "fontSize": 0,
- "text": "string"
}, - "shape": "string",
- "size": 0,
- "color": "string",
- "fade": true,
- "data": {
- "property1": { },
- "property2": { }
}, - "glyphs": [
- {
- "angle": 0,
- "blink": true,
- "border": {
- "color": "string"
}, - "color": "string",
- "fontIcon": {
- "color": "string",
- "fontFamily": "string",
- "text": "string"
}, - "image": "string",
- "label": {
- "bold": true,
- "color": "string",
- "fontFamily": "string",
- "text": "string"
}, - "position": "string",
- "radius": 0,
- "size": 0
}
]
}
}Get a list, graph, or count of the principals that can control this domain.
| object_id required | string (object-id) The object id of the entity being operated on. |
| skip | integer >= 0 Default: 0 The number of entries to skip for pagination. Only available for |
| limit | integer >= 0 Default: 10 The number of entries to limit in the response. Only available for |
| type | string Default: "list" Enum: "list" "graph" "count" The type of return data requested. If no type is provided, query will default to |
| sort_by | string (sort-by) Sort by column. Can be used multiple times; prepend a hyphen for descending order. Columns available for sorting are dependent on the entity object kind. |
| Prefer | integer [ 0 .. 60 ] Default: 30 Prefer header, used to specify a custom timeout in seconds using the wait parameter as per RFC7240. The default timeout is 30 seconds and maximum timeout is 60 seconds |
{- "property1": {
- "border": {
- "color": "string",
- "lineStyle": "string",
- "width": 0
}, - "coordinates": {
- "lat": 0,
- "lng": 0
}, - "cutout": true,
- "fontIcon": {
- "color": "string",
- "fontFamily": "string",
- "text": "string"
}, - "halos": [
- {
- "color": "string",
- "radius": 0,
- "width": 0
}
], - "image": "string",
- "label": {
- "backgroundColor": "string",
- "bold": true,
- "center": true,
- "color": "string",
- "fontFamily": "string",
- "fontSize": 0,
- "text": "string"
}, - "shape": "string",
- "size": 0,
- "color": "string",
- "fade": true,
- "data": {
- "property1": { },
- "property2": { }
}, - "glyphs": [
- {
- "angle": 0,
- "blink": true,
- "border": {
- "color": "string"
}, - "color": "string",
- "fontIcon": {
- "color": "string",
- "fontFamily": "string",
- "text": "string"
}, - "image": "string",
- "label": {
- "bold": true,
- "color": "string",
- "fontFamily": "string",
- "text": "string"
}, - "position": "string",
- "radius": 0,
- "size": 0
}
]
}, - "property2": {
- "border": {
- "color": "string",
- "lineStyle": "string",
- "width": 0
}, - "coordinates": {
- "lat": 0,
- "lng": 0
}, - "cutout": true,
- "fontIcon": {
- "color": "string",
- "fontFamily": "string",
- "text": "string"
}, - "halos": [
- {
- "color": "string",
- "radius": 0,
- "width": 0
}
], - "image": "string",
- "label": {
- "backgroundColor": "string",
- "bold": true,
- "center": true,
- "color": "string",
- "fontFamily": "string",
- "fontSize": 0,
- "text": "string"
}, - "shape": "string",
- "size": 0,
- "color": "string",
- "fade": true,
- "data": {
- "property1": { },
- "property2": { }
}, - "glyphs": [
- {
- "angle": 0,
- "blink": true,
- "border": {
- "color": "string"
}, - "color": "string",
- "fontIcon": {
- "color": "string",
- "fontFamily": "string",
- "text": "string"
}, - "image": "string",
- "label": {
- "bold": true,
- "color": "string",
- "fontFamily": "string",
- "text": "string"
}, - "position": "string",
- "radius": 0,
- "size": 0
}
]
}
}Get a list, graph, or count of the principals that can DC sync this domain.
| object_id required | string (object-id) The object id of the entity being operated on. |
| skip | integer >= 0 Default: 0 The number of entries to skip for pagination. Only available for |
| limit | integer >= 0 Default: 10 The number of entries to limit in the response. Only available for |
| type | string Default: "list" Enum: "list" "graph" "count" The type of return data requested. If no type is provided, query will default to |
| sort_by | string (sort-by) Sort by column. Can be used multiple times; prepend a hyphen for descending order. Columns available for sorting are dependent on the entity object kind. |
| Prefer | integer [ 0 .. 60 ] Default: 30 Prefer header, used to specify a custom timeout in seconds using the wait parameter as per RFC7240. The default timeout is 30 seconds and maximum timeout is 60 seconds |
{- "property1": {
- "border": {
- "color": "string",
- "lineStyle": "string",
- "width": 0
}, - "coordinates": {
- "lat": 0,
- "lng": 0
}, - "cutout": true,
- "fontIcon": {
- "color": "string",
- "fontFamily": "string",
- "text": "string"
}, - "halos": [
- {
- "color": "string",
- "radius": 0,
- "width": 0
}
], - "image": "string",
- "label": {
- "backgroundColor": "string",
- "bold": true,
- "center": true,
- "color": "string",
- "fontFamily": "string",
- "fontSize": 0,
- "text": "string"
}, - "shape": "string",
- "size": 0,
- "color": "string",
- "fade": true,
- "data": {
- "property1": { },
- "property2": { }
}, - "glyphs": [
- {
- "angle": 0,
- "blink": true,
- "border": {
- "color": "string"
}, - "color": "string",
- "fontIcon": {
- "color": "string",
- "fontFamily": "string",
- "text": "string"
}, - "image": "string",
- "label": {
- "bold": true,
- "color": "string",
- "fontFamily": "string",
- "text": "string"
}, - "position": "string",
- "radius": 0,
- "size": 0
}
]
}, - "property2": {
- "border": {
- "color": "string",
- "lineStyle": "string",
- "width": 0
}, - "coordinates": {
- "lat": 0,
- "lng": 0
}, - "cutout": true,
- "fontIcon": {
- "color": "string",
- "fontFamily": "string",
- "text": "string"
}, - "halos": [
- {
- "color": "string",
- "radius": 0,
- "width": 0
}
], - "image": "string",
- "label": {
- "backgroundColor": "string",
- "bold": true,
- "center": true,
- "color": "string",
- "fontFamily": "string",
- "fontSize": 0,
- "text": "string"
}, - "shape": "string",
- "size": 0,
- "color": "string",
- "fade": true,
- "data": {
- "property1": { },
- "property2": { }
}, - "glyphs": [
- {
- "angle": 0,
- "blink": true,
- "border": {
- "color": "string"
}, - "color": "string",
- "fontIcon": {
- "color": "string",
- "fontFamily": "string",
- "text": "string"
}, - "image": "string",
- "label": {
- "bold": true,
- "color": "string",
- "fontFamily": "string",
- "text": "string"
}, - "position": "string",
- "radius": 0,
- "size": 0
}
]
}
}Get a list, graph, or count of the principals outside of this domain that have admin rights on principals in this domain.
| object_id required | string (object-id) The object id of the entity being operated on. |
| skip | integer >= 0 Default: 0 The number of entries to skip for pagination. Only available for |
| limit | integer >= 0 Default: 10 The number of entries to limit in the response. Only available for |
| type | string Default: "list" Enum: "list" "graph" "count" The type of return data requested. If no type is provided, query will default to |
| sort_by | string (sort-by) Sort by column. Can be used multiple times; prepend a hyphen for descending order. Columns available for sorting are dependent on the entity object kind. |
| Prefer | integer [ 0 .. 60 ] Default: 30 Prefer header, used to specify a custom timeout in seconds using the wait parameter as per RFC7240. The default timeout is 30 seconds and maximum timeout is 60 seconds |
{- "property1": {
- "border": {
- "color": "string",
- "lineStyle": "string",
- "width": 0
}, - "coordinates": {
- "lat": 0,
- "lng": 0
}, - "cutout": true,
- "fontIcon": {
- "color": "string",
- "fontFamily": "string",
- "text": "string"
}, - "halos": [
- {
- "color": "string",
- "radius": 0,
- "width": 0
}
], - "image": "string",
- "label": {
- "backgroundColor": "string",
- "bold": true,
- "center": true,
- "color": "string",
- "fontFamily": "string",
- "fontSize": 0,
- "text": "string"
}, - "shape": "string",
- "size": 0,
- "color": "string",
- "fade": true,
- "data": {
- "property1": { },
- "property2": { }
}, - "glyphs": [
- {
- "angle": 0,
- "blink": true,
- "border": {
- "color": "string"
}, - "color": "string",
- "fontIcon": {
- "color": "string",
- "fontFamily": "string",
- "text": "string"
}, - "image": "string",
- "label": {
- "bold": true,
- "color": "string",
- "fontFamily": "string",
- "text": "string"
}, - "position": "string",
- "radius": 0,
- "size": 0
}
]
}, - "property2": {
- "border": {
- "color": "string",
- "lineStyle": "string",
- "width": 0
}, - "coordinates": {
- "lat": 0,
- "lng": 0
}, - "cutout": true,
- "fontIcon": {
- "color": "string",
- "fontFamily": "string",
- "text": "string"
}, - "halos": [
- {
- "color": "string",
- "radius": 0,
- "width": 0
}
], - "image": "string",
- "label": {
- "backgroundColor": "string",
- "bold": true,
- "center": true,
- "color": "string",
- "fontFamily": "string",
- "fontSize": 0,
- "text": "string"
}, - "shape": "string",
- "size": 0,
- "color": "string",
- "fade": true,
- "data": {
- "property1": { },
- "property2": { }
}, - "glyphs": [
- {
- "angle": 0,
- "blink": true,
- "border": {
- "color": "string"
}, - "color": "string",
- "fontIcon": {
- "color": "string",
- "fontFamily": "string",
- "text": "string"
}, - "image": "string",
- "label": {
- "bold": true,
- "color": "string",
- "fontFamily": "string",
- "text": "string"
}, - "position": "string",
- "radius": 0,
- "size": 0
}
]
}
}Get a list, graph, or count of the principals outside of this domain that can control GPOs inside this domain.
| object_id required | string (object-id) The object id of the entity being operated on. |
| skip | integer >= 0 Default: 0 The number of entries to skip for pagination. Only available for |
| limit | integer >= 0 Default: 10 The number of entries to limit in the response. Only available for |
| type | string Default: "list" Enum: "list" "graph" "count" The type of return data requested. If no type is provided, query will default to |
| sort_by | string (sort-by) Sort by column. Can be used multiple times; prepend a hyphen for descending order. Columns available for sorting are dependent on the entity object kind. |
| Prefer | integer [ 0 .. 60 ] Default: 30 Prefer header, used to specify a custom timeout in seconds using the wait parameter as per RFC7240. The default timeout is 30 seconds and maximum timeout is 60 seconds |
{- "property1": {
- "border": {
- "color": "string",
- "lineStyle": "string",
- "width": 0
}, - "coordinates": {
- "lat": 0,
- "lng": 0
}, - "cutout": true,
- "fontIcon": {
- "color": "string",
- "fontFamily": "string",
- "text": "string"
}, - "halos": [
- {
- "color": "string",
- "radius": 0,
- "width": 0
}
], - "image": "string",
- "label": {
- "backgroundColor": "string",
- "bold": true,
- "center": true,
- "color": "string",
- "fontFamily": "string",
- "fontSize": 0,
- "text": "string"
}, - "shape": "string",
- "size": 0,
- "color": "string",
- "fade": true,
- "data": {
- "property1": { },
- "property2": { }
}, - "glyphs": [
- {
- "angle": 0,
- "blink": true,
- "border": {
- "color": "string"
}, - "color": "string",
- "fontIcon": {
- "color": "string",
- "fontFamily": "string",
- "text": "string"
}, - "image": "string",
- "label": {
- "bold": true,
- "color": "string",
- "fontFamily": "string",
- "text": "string"
}, - "position": "string",
- "radius": 0,
- "size": 0
}
]
}, - "property2": {
- "border": {
- "color": "string",
- "lineStyle": "string",
- "width": 0
}, - "coordinates": {
- "lat": 0,
- "lng": 0
}, - "cutout": true,
- "fontIcon": {
- "color": "string",
- "fontFamily": "string",
- "text": "string"
}, - "halos": [
- {
- "color": "string",
- "radius": 0,
- "width": 0
}
], - "image": "string",
- "label": {
- "backgroundColor": "string",
- "bold": true,
- "center": true,
- "color": "string",
- "fontFamily": "string",
- "fontSize": 0,
- "text": "string"
}, - "shape": "string",
- "size": 0,
- "color": "string",
- "fade": true,
- "data": {
- "property1": { },
- "property2": { }
}, - "glyphs": [
- {
- "angle": 0,
- "blink": true,
- "border": {
- "color": "string"
}, - "color": "string",
- "fontIcon": {
- "color": "string",
- "fontFamily": "string",
- "text": "string"
}, - "image": "string",
- "label": {
- "bold": true,
- "color": "string",
- "fontFamily": "string",
- "text": "string"
}, - "position": "string",
- "radius": 0,
- "size": 0
}
]
}
}Get a list, graph, or count of the groups outside of this domain that are members of groups inside this domain.
| object_id required | string (object-id) The object id of the entity being operated on. |
| skip | integer >= 0 Default: 0 The number of entries to skip for pagination. Only available for |
| limit | integer >= 0 Default: 10 The number of entries to limit in the response. Only available for |
| type | string Default: "list" Enum: "list" "graph" "count" The type of return data requested. If no type is provided, query will default to |
| sort_by | string (sort-by) Sort by column. Can be used multiple times; prepend a hyphen for descending order. Columns available for sorting are dependent on the entity object kind. |
| Prefer | integer [ 0 .. 60 ] Default: 30 Prefer header, used to specify a custom timeout in seconds using the wait parameter as per RFC7240. The default timeout is 30 seconds and maximum timeout is 60 seconds |
{- "property1": {
- "border": {
- "color": "string",
- "lineStyle": "string",
- "width": 0
}, - "coordinates": {
- "lat": 0,
- "lng": 0
}, - "cutout": true,
- "fontIcon": {
- "color": "string",
- "fontFamily": "string",
- "text": "string"
}, - "halos": [
- {
- "color": "string",
- "radius": 0,
- "width": 0
}
], - "image": "string",
- "label": {
- "backgroundColor": "string",
- "bold": true,
- "center": true,
- "color": "string",
- "fontFamily": "string",
- "fontSize": 0,
- "text": "string"
}, - "shape": "string",
- "size": 0,
- "color": "string",
- "fade": true,
- "data": {
- "property1": { },
- "property2": { }
}, - "glyphs": [
- {
- "angle": 0,
- "blink": true,
- "border": {
- "color": "string"
}, - "color": "string",
- "fontIcon": {
- "color": "string",
- "fontFamily": "string",
- "text": "string"
}, - "image": "string",
- "label": {
- "bold": true,
- "color": "string",
- "fontFamily": "string",
- "text": "string"
}, - "position": "string",
- "radius": 0,
- "size": 0
}
]
}, - "property2": {
- "border": {
- "color": "string",
- "lineStyle": "string",
- "width": 0
}, - "coordinates": {
- "lat": 0,
- "lng": 0
}, - "cutout": true,
- "fontIcon": {
- "color": "string",
- "fontFamily": "string",
- "text": "string"
}, - "halos": [
- {
- "color": "string",
- "radius": 0,
- "width": 0
}
], - "image": "string",
- "label": {
- "backgroundColor": "string",
- "bold": true,
- "center": true,
- "color": "string",
- "fontFamily": "string",
- "fontSize": 0,
- "text": "string"
}, - "shape": "string",
- "size": 0,
- "color": "string",
- "fade": true,
- "data": {
- "property1": { },
- "property2": { }
}, - "glyphs": [
- {
- "angle": 0,
- "blink": true,
- "border": {
- "color": "string"
}, - "color": "string",
- "fontIcon": {
- "color": "string",
- "fontFamily": "string",
- "text": "string"
}, - "image": "string",
- "label": {
- "bold": true,
- "color": "string",
- "fontFamily": "string",
- "text": "string"
}, - "position": "string",
- "radius": 0,
- "size": 0
}
]
}
}Get a list, graph, or count of the users outside of this domain that are members of groups inside this domain.
| object_id required | string (object-id) The object id of the entity being operated on. |
| skip | integer >= 0 Default: 0 The number of entries to skip for pagination. Only available for |
| limit | integer >= 0 Default: 10 The number of entries to limit in the response. Only available for |
| type | string Default: "list" Enum: "list" "graph" "count" The type of return data requested. If no type is provided, query will default to |
| sort_by | string (sort-by) Sort by column. Can be used multiple times; prepend a hyphen for descending order. Columns available for sorting are dependent on the entity object kind. |
| Prefer | integer [ 0 .. 60 ] Default: 30 Prefer header, used to specify a custom timeout in seconds using the wait parameter as per RFC7240. The default timeout is 30 seconds and maximum timeout is 60 seconds |
{- "property1": {
- "border": {
- "color": "string",
- "lineStyle": "string",
- "width": 0
}, - "coordinates": {
- "lat": 0,
- "lng": 0
}, - "cutout": true,
- "fontIcon": {
- "color": "string",
- "fontFamily": "string",
- "text": "string"
}, - "halos": [
- {
- "color": "string",
- "radius": 0,
- "width": 0
}
], - "image": "string",
- "label": {
- "backgroundColor": "string",
- "bold": true,
- "center": true,
- "color": "string",
- "fontFamily": "string",
- "fontSize": 0,
- "text": "string"
}, - "shape": "string",
- "size": 0,
- "color": "string",
- "fade": true,
- "data": {
- "property1": { },
- "property2": { }
}, - "glyphs": [
- {
- "angle": 0,
- "blink": true,
- "border": {
- "color": "string"
}, - "color": "string",
- "fontIcon": {
- "color": "string",
- "fontFamily": "string",
- "text": "string"
}, - "image": "string",
- "label": {
- "bold": true,
- "color": "string",
- "fontFamily": "string",
- "text": "string"
}, - "position": "string",
- "radius": 0,
- "size": 0
}
]
}, - "property2": {
- "border": {
- "color": "string",
- "lineStyle": "string",
- "width": 0
}, - "coordinates": {
- "lat": 0,
- "lng": 0
}, - "cutout": true,
- "fontIcon": {
- "color": "string",
- "fontFamily": "string",
- "text": "string"
}, - "halos": [
- {
- "color": "string",
- "radius": 0,
- "width": 0
}
], - "image": "string",
- "label": {
- "backgroundColor": "string",
- "bold": true,
- "center": true,
- "color": "string",
- "fontFamily": "string",
- "fontSize": 0,
- "text": "string"
}, - "shape": "string",
- "size": 0,
- "color": "string",
- "fade": true,
- "data": {
- "property1": { },
- "property2": { }
}, - "glyphs": [
- {
- "angle": 0,
- "blink": true,
- "border": {
- "color": "string"
}, - "color": "string",
- "fontIcon": {
- "color": "string",
- "fontFamily": "string",
- "text": "string"
}, - "image": "string",
- "label": {
- "bold": true,
- "color": "string",
- "fontFamily": "string",
- "text": "string"
}, - "position": "string",
- "radius": 0,
- "size": 0
}
]
}
}Get a list or count of the GPOs in this domain.
| object_id required | string (object-id) The object id of the entity being operated on. |
| skip | integer >= 0 Default: 0 The number of entries to skip for pagination. Only available for |
| limit | integer >= 0 Default: 10 The number of entries to limit in the response. Only available for |
| type | string Default: "list" Enum: "list" "graph" "count" The type of return data requested. If no type is provided, query will default to |
| sort_by | string (sort-by) Sort by column. Can be used multiple times; prepend a hyphen for descending order. Columns available for sorting are dependent on the entity object kind. |
| Prefer | integer [ 0 .. 60 ] Default: 30 Prefer header, used to specify a custom timeout in seconds using the wait parameter as per RFC7240. The default timeout is 30 seconds and maximum timeout is 60 seconds |
{- "property1": {
- "border": {
- "color": "string",
- "lineStyle": "string",
- "width": 0
}, - "coordinates": {
- "lat": 0,
- "lng": 0
}, - "cutout": true,
- "fontIcon": {
- "color": "string",
- "fontFamily": "string",
- "text": "string"
}, - "halos": [
- {
- "color": "string",
- "radius": 0,
- "width": 0
}
], - "image": "string",
- "label": {
- "backgroundColor": "string",
- "bold": true,
- "center": true,
- "color": "string",
- "fontFamily": "string",
- "fontSize": 0,
- "text": "string"
}, - "shape": "string",
- "size": 0,
- "color": "string",
- "fade": true,
- "data": {
- "property1": { },
- "property2": { }
}, - "glyphs": [
- {
- "angle": 0,
- "blink": true,
- "border": {
- "color": "string"
}, - "color": "string",
- "fontIcon": {
- "color": "string",
- "fontFamily": "string",
- "text": "string"
}, - "image": "string",
- "label": {
- "bold": true,
- "color": "string",
- "fontFamily": "string",
- "text": "string"
}, - "position": "string",
- "radius": 0,
- "size": 0
}
]
}, - "property2": {
- "border": {
- "color": "string",
- "lineStyle": "string",
- "width": 0
}, - "coordinates": {
- "lat": 0,
- "lng": 0
}, - "cutout": true,
- "fontIcon": {
- "color": "string",
- "fontFamily": "string",
- "text": "string"
}, - "halos": [
- {
- "color": "string",
- "radius": 0,
- "width": 0
}
], - "image": "string",
- "label": {
- "backgroundColor": "string",
- "bold": true,
- "center": true,
- "color": "string",
- "fontFamily": "string",
- "fontSize": 0,
- "text": "string"
}, - "shape": "string",
- "size": 0,
- "color": "string",
- "fade": true,
- "data": {
- "property1": { },
- "property2": { }
}, - "glyphs": [
- {
- "angle": 0,
- "blink": true,
- "border": {
- "color": "string"
}, - "color": "string",
- "fontIcon": {
- "color": "string",
- "fontFamily": "string",
- "text": "string"
}, - "image": "string",
- "label": {
- "bold": true,
- "color": "string",
- "fontFamily": "string",
- "text": "string"
}, - "position": "string",
- "radius": 0,
- "size": 0
}
]
}
}Get a list or count of the groups in this domain.
| object_id required | string (object-id) The object id of the entity being operated on. |
| skip | integer >= 0 Default: 0 The number of entries to skip for pagination. Only available for |
| limit | integer >= 0 Default: 10 The number of entries to limit in the response. Only available for |
| type | string Default: "list" Enum: "list" "graph" "count" The type of return data requested. If no type is provided, query will default to |
| sort_by | string (sort-by) Sort by column. Can be used multiple times; prepend a hyphen for descending order. Columns available for sorting are dependent on the entity object kind. |
| Prefer | integer [ 0 .. 60 ] Default: 30 Prefer header, used to specify a custom timeout in seconds using the wait parameter as per RFC7240. The default timeout is 30 seconds and maximum timeout is 60 seconds |
{- "property1": {
- "border": {
- "color": "string",
- "lineStyle": "string",
- "width": 0
}, - "coordinates": {
- "lat": 0,
- "lng": 0
}, - "cutout": true,
- "fontIcon": {
- "color": "string",
- "fontFamily": "string",
- "text": "string"
}, - "halos": [
- {
- "color": "string",
- "radius": 0,
- "width": 0
}
], - "image": "string",
- "label": {
- "backgroundColor": "string",
- "bold": true,
- "center": true,
- "color": "string",
- "fontFamily": "string",
- "fontSize": 0,
- "text": "string"
}, - "shape": "string",
- "size": 0,
- "color": "string",
- "fade": true,
- "data": {
- "property1": { },
- "property2": { }
}, - "glyphs": [
- {
- "angle": 0,
- "blink": true,
- "border": {
- "color": "string"
}, - "color": "string",
- "fontIcon": {
- "color": "string",
- "fontFamily": "string",
- "text": "string"
}, - "image": "string",
- "label": {
- "bold": true,
- "color": "string",
- "fontFamily": "string",
- "text": "string"
}, - "position": "string",
- "radius": 0,
- "size": 0
}
]
}, - "property2": {
- "border": {
- "color": "string",
- "lineStyle": "string",
- "width": 0
}, - "coordinates": {
- "lat": 0,
- "lng": 0
}, - "cutout": true,
- "fontIcon": {
- "color": "string",
- "fontFamily": "string",
- "text": "string"
}, - "halos": [
- {
- "color": "string",
- "radius": 0,
- "width": 0
}
], - "image": "string",
- "label": {
- "backgroundColor": "string",
- "bold": true,
- "center": true,
- "color": "string",
- "fontFamily": "string",
- "fontSize": 0,
- "text": "string"
}, - "shape": "string",
- "size": 0,
- "color": "string",
- "fade": true,
- "data": {
- "property1": { },
- "property2": { }
}, - "glyphs": [
- {
- "angle": 0,
- "blink": true,
- "border": {
- "color": "string"
}, - "color": "string",
- "fontIcon": {
- "color": "string",
- "fontFamily": "string",
- "text": "string"
}, - "image": "string",
- "label": {
- "bold": true,
- "color": "string",
- "fontFamily": "string",
- "text": "string"
}, - "position": "string",
- "radius": 0,
- "size": 0
}
]
}
}Get a list, graph, or count of the inbound trusts for this domain.
| object_id required | string (object-id) The object id of the entity being operated on. |
| skip | integer >= 0 Default: 0 The number of entries to skip for pagination. Only available for |
| limit | integer >= 0 Default: 10 The number of entries to limit in the response. Only available for |
| type | string Default: "list" Enum: "list" "graph" "count" The type of return data requested. If no type is provided, query will default to |
| sort_by | string (sort-by) Sort by column. Can be used multiple times; prepend a hyphen for descending order. Columns available for sorting are dependent on the entity object kind. |
| Prefer | integer [ 0 .. 60 ] Default: 30 Prefer header, used to specify a custom timeout in seconds using the wait parameter as per RFC7240. The default timeout is 30 seconds and maximum timeout is 60 seconds |
{- "property1": {
- "border": {
- "color": "string",
- "lineStyle": "string",
- "width": 0
}, - "coordinates": {
- "lat": 0,
- "lng": 0
}, - "cutout": true,
- "fontIcon": {
- "color": "string",
- "fontFamily": "string",
- "text": "string"
}, - "halos": [
- {
- "color": "string",
- "radius": 0,
- "width": 0
}
], - "image": "string",
- "label": {
- "backgroundColor": "string",
- "bold": true,
- "center": true,
- "color": "string",
- "fontFamily": "string",
- "fontSize": 0,
- "text": "string"
}, - "shape": "string",
- "size": 0,
- "color": "string",
- "fade": true,
- "data": {
- "property1": { },
- "property2": { }
}, - "glyphs": [
- {
- "angle": 0,
- "blink": true,
- "border": {
- "color": "string"
}, - "color": "string",
- "fontIcon": {
- "color": "string",
- "fontFamily": "string",
- "text": "string"
}, - "image": "string",
- "label": {
- "bold": true,
- "color": "string",
- "fontFamily": "string",
- "text": "string"
}, - "position": "string",
- "radius": 0,
- "size": 0
}
]
}, - "property2": {
- "border": {
- "color": "string",
- "lineStyle": "string",
- "width": 0
}, - "coordinates": {
- "lat": 0,
- "lng": 0
}, - "cutout": true,
- "fontIcon": {
- "color": "string",
- "fontFamily": "string",
- "text": "string"
}, - "halos": [
- {
- "color": "string",
- "radius": 0,
- "width": 0
}
], - "image": "string",
- "label": {
- "backgroundColor": "string",
- "bold": true,
- "center": true,
- "color": "string",
- "fontFamily": "string",
- "fontSize": 0,
- "text": "string"
}, - "shape": "string",
- "size": 0,
- "color": "string",
- "fade": true,
- "data": {
- "property1": { },
- "property2": { }
}, - "glyphs": [
- {
- "angle": 0,
- "blink": true,
- "border": {
- "color": "string"
}, - "color": "string",
- "fontIcon": {
- "color": "string",
- "fontFamily": "string",
- "text": "string"
}, - "image": "string",
- "label": {
- "bold": true,
- "color": "string",
- "fontFamily": "string",
- "text": "string"
}, - "position": "string",
- "radius": 0,
- "size": 0
}
]
}
}Get a list, graph, or count of the GPOs linked to this domain.
| object_id required | string (object-id) The object id of the entity being operated on. |
| skip | integer >= 0 Default: 0 The number of entries to skip for pagination. Only available for |
| limit | integer >= 0 Default: 10 The number of entries to limit in the response. Only available for |
| type | string Default: "list" Enum: "list" "graph" "count" The type of return data requested. If no type is provided, query will default to |
| sort_by | string (sort-by) Sort by column. Can be used multiple times; prepend a hyphen for descending order. Columns available for sorting are dependent on the entity object kind. |
| Prefer | integer [ 0 .. 60 ] Default: 30 Prefer header, used to specify a custom timeout in seconds using the wait parameter as per RFC7240. The default timeout is 30 seconds and maximum timeout is 60 seconds |
{- "property1": {
- "border": {
- "color": "string",
- "lineStyle": "string",
- "width": 0
}, - "coordinates": {
- "lat": 0,
- "lng": 0
}, - "cutout": true,
- "fontIcon": {
- "color": "string",
- "fontFamily": "string",
- "text": "string"
}, - "halos": [
- {
- "color": "string",
- "radius": 0,
- "width": 0
}
], - "image": "string",
- "label": {
- "backgroundColor": "string",
- "bold": true,
- "center": true,
- "color": "string",
- "fontFamily": "string",
- "fontSize": 0,
- "text": "string"
}, - "shape": "string",
- "size": 0,
- "color": "string",
- "fade": true,
- "data": {
- "property1": { },
- "property2": { }
}, - "glyphs": [
- {
- "angle": 0,
- "blink": true,
- "border": {
- "color": "string"
}, - "color": "string",
- "fontIcon": {
- "color": "string",
- "fontFamily": "string",
- "text": "string"
}, - "image": "string",
- "label": {
- "bold": true,
- "color": "string",
- "fontFamily": "string",
- "text": "string"
}, - "position": "string",
- "radius": 0,
- "size": 0
}
]
}, - "property2": {
- "border": {
- "color": "string",
- "lineStyle": "string",
- "width": 0
}, - "coordinates": {
- "lat": 0,
- "lng": 0
}, - "cutout": true,
- "fontIcon": {
- "color": "string",
- "fontFamily": "string",
- "text": "string"
}, - "halos": [
- {
- "color": "string",
- "radius": 0,
- "width": 0
}
], - "image": "string",
- "label": {
- "backgroundColor": "string",
- "bold": true,
- "center": true,
- "color": "string",
- "fontFamily": "string",
- "fontSize": 0,
- "text": "string"
}, - "shape": "string",
- "size": 0,
- "color": "string",
- "fade": true,
- "data": {
- "property1": { },
- "property2": { }
}, - "glyphs": [
- {
- "angle": 0,
- "blink": true,
- "border": {
- "color": "string"
}, - "color": "string",
- "fontIcon": {
- "color": "string",
- "fontFamily": "string",
- "text": "string"
}, - "image": "string",
- "label": {
- "bold": true,
- "color": "string",
- "fontFamily": "string",
- "text": "string"
}, - "position": "string",
- "radius": 0,
- "size": 0
}
]
}
}Get a list or count of the OUs in this domain.
| object_id required | string (object-id) The object id of the entity being operated on. |
| skip | integer >= 0 Default: 0 The number of entries to skip for pagination. Only available for |
| limit | integer >= 0 Default: 10 The number of entries to limit in the response. Only available for |
| type | string Default: "list" Enum: "list" "graph" "count" The type of return data requested. If no type is provided, query will default to |
| sort_by | string (sort-by) Sort by column. Can be used multiple times; prepend a hyphen for descending order. Columns available for sorting are dependent on the entity object kind. |
| Prefer | integer [ 0 .. 60 ] Default: 30 Prefer header, used to specify a custom timeout in seconds using the wait parameter as per RFC7240. The default timeout is 30 seconds and maximum timeout is 60 seconds |
{- "property1": {
- "border": {
- "color": "string",
- "lineStyle": "string",
- "width": 0
}, - "coordinates": {
- "lat": 0,
- "lng": 0
}, - "cutout": true,
- "fontIcon": {
- "color": "string",
- "fontFamily": "string",
- "text": "string"
}, - "halos": [
- {
- "color": "string",
- "radius": 0,
- "width": 0
}
], - "image": "string",
- "label": {
- "backgroundColor": "string",
- "bold": true,
- "center": true,
- "color": "string",
- "fontFamily": "string",
- "fontSize": 0,
- "text": "string"
}, - "shape": "string",
- "size": 0,
- "color": "string",
- "fade": true,
- "data": {
- "property1": { },
- "property2": { }
}, - "glyphs": [
- {
- "angle": 0,
- "blink": true,
- "border": {
- "color": "string"
}, - "color": "string",
- "fontIcon": {
- "color": "string",
- "fontFamily": "string",
- "text": "string"
}, - "image": "string",
- "label": {
- "bold": true,
- "color": "string",
- "fontFamily": "string",
- "text": "string"
}, - "position": "string",
- "radius": 0,
- "size": 0
}
]
}, - "property2": {
- "border": {
- "color": "string",
- "lineStyle": "string",
- "width": 0
}, - "coordinates": {
- "lat": 0,
- "lng": 0
}, - "cutout": true,
- "fontIcon": {
- "color": "string",
- "fontFamily": "string",
- "text": "string"
}, - "halos": [
- {
- "color": "string",
- "radius": 0,
- "width": 0
}
], - "image": "string",
- "label": {
- "backgroundColor": "string",
- "bold": true,
- "center": true,
- "color": "string",
- "fontFamily": "string",
- "fontSize": 0,
- "text": "string"
}, - "shape": "string",
- "size": 0,
- "color": "string",
- "fade": true,
- "data": {
- "property1": { },
- "property2": { }
}, - "glyphs": [
- {
- "angle": 0,
- "blink": true,
- "border": {
- "color": "string"
}, - "color": "string",
- "fontIcon": {
- "color": "string",
- "fontFamily": "string",
- "text": "string"
}, - "image": "string",
- "label": {
- "bold": true,
- "color": "string",
- "fontFamily": "string",
- "text": "string"
}, - "position": "string",
- "radius": 0,
- "size": 0
}
]
}
}Get a list, graph, or count of the outbound trusts for this domain.
| object_id required | string (object-id) The object id of the entity being operated on. |
| skip | integer >= 0 Default: 0 The number of entries to skip for pagination. Only available for |
| limit | integer >= 0 Default: 10 The number of entries to limit in the response. Only available for |
| type | string Default: "list" Enum: "list" "graph" "count" The type of return data requested. If no type is provided, query will default to |
| sort_by | string (sort-by) Sort by column. Can be used multiple times; prepend a hyphen for descending order. Columns available for sorting are dependent on the entity object kind. |
| Prefer | integer [ 0 .. 60 ] Default: 30 Prefer header, used to specify a custom timeout in seconds using the wait parameter as per RFC7240. The default timeout is 30 seconds and maximum timeout is 60 seconds |
{- "property1": {
- "border": {
- "color": "string",
- "lineStyle": "string",
- "width": 0
}, - "coordinates": {
- "lat": 0,
- "lng": 0
}, - "cutout": true,
- "fontIcon": {
- "color": "string",
- "fontFamily": "string",
- "text": "string"
}, - "halos": [
- {
- "color": "string",
- "radius": 0,
- "width": 0
}
], - "image": "string",
- "label": {
- "backgroundColor": "string",
- "bold": true,
- "center": true,
- "color": "string",
- "fontFamily": "string",
- "fontSize": 0,
- "text": "string"
}, - "shape": "string",
- "size": 0,
- "color": "string",
- "fade": true,
- "data": {
- "property1": { },
- "property2": { }
}, - "glyphs": [
- {
- "angle": 0,
- "blink": true,
- "border": {
- "color": "string"
}, - "color": "string",
- "fontIcon": {
- "color": "string",
- "fontFamily": "string",
- "text": "string"
}, - "image": "string",
- "label": {
- "bold": true,
- "color": "string",
- "fontFamily": "string",
- "text": "string"
}, - "position": "string",
- "radius": 0,
- "size": 0
}
]
}, - "property2": {
- "border": {
- "color": "string",
- "lineStyle": "string",
- "width": 0
}, - "coordinates": {
- "lat": 0,
- "lng": 0
}, - "cutout": true,
- "fontIcon": {
- "color": "string",
- "fontFamily": "string",
- "text": "string"
}, - "halos": [
- {
- "color": "string",
- "radius": 0,
- "width": 0
}
], - "image": "string",
- "label": {
- "backgroundColor": "string",
- "bold": true,
- "center": true,
- "color": "string",
- "fontFamily": "string",
- "fontSize": 0,
- "text": "string"
}, - "shape": "string",
- "size": 0,
- "color": "string",
- "fade": true,
- "data": {
- "property1": { },
- "property2": { }
}, - "glyphs": [
- {
- "angle": 0,
- "blink": true,
- "border": {
- "color": "string"
}, - "color": "string",
- "fontIcon": {
- "color": "string",
- "fontFamily": "string",
- "text": "string"
}, - "image": "string",
- "label": {
- "bold": true,
- "color": "string",
- "fontFamily": "string",
- "text": "string"
}, - "position": "string",
- "radius": 0,
- "size": 0
}
]
}
}Get a list or count of the users in this domain.
| object_id required | string (object-id) The object id of the entity being operated on. |
| skip | integer >= 0 Default: 0 The number of entries to skip for pagination. Only available for |
| limit | integer >= 0 Default: 10 The number of entries to limit in the response. Only available for |
| type | string Default: "list" Enum: "list" "graph" "count" The type of return data requested. If no type is provided, query will default to |
| sort_by | string (sort-by) Sort by column. Can be used multiple times; prepend a hyphen for descending order. Columns available for sorting are dependent on the entity object kind. |
| Prefer | integer [ 0 .. 60 ] Default: 30 Prefer header, used to specify a custom timeout in seconds using the wait parameter as per RFC7240. The default timeout is 30 seconds and maximum timeout is 60 seconds |
{- "property1": {
- "border": {
- "color": "string",
- "lineStyle": "string",
- "width": 0
}, - "coordinates": {
- "lat": 0,
- "lng": 0
}, - "cutout": true,
- "fontIcon": {
- "color": "string",
- "fontFamily": "string",
- "text": "string"
}, - "halos": [
- {
- "color": "string",
- "radius": 0,
- "width": 0
}
], - "image": "string",
- "label": {
- "backgroundColor": "string",
- "bold": true,
- "center": true,
- "color": "string",
- "fontFamily": "string",
- "fontSize": 0,
- "text": "string"
}, - "shape": "string",
- "size": 0,
- "color": "string",
- "fade": true,
- "data": {
- "property1": { },
- "property2": { }
}, - "glyphs": [
- {
- "angle": 0,
- "blink": true,
- "border": {
- "color": "string"
}, - "color": "string",
- "fontIcon": {
- "color": "string",
- "fontFamily": "string",
- "text": "string"
}, - "image": "string",
- "label": {
- "bold": true,
- "color": "string",
- "fontFamily": "string",
- "text": "string"
}, - "position": "string",
- "radius": 0,
- "size": 0
}
]
}, - "property2": {
- "border": {
- "color": "string",
- "lineStyle": "string",
- "width": 0
}, - "coordinates": {
- "lat": 0,
- "lng": 0
}, - "cutout": true,
- "fontIcon": {
- "color": "string",
- "fontFamily": "string",
- "text": "string"
}, - "halos": [
- {
- "color": "string",
- "radius": 0,
- "width": 0
}
], - "image": "string",
- "label": {
- "backgroundColor": "string",
- "bold": true,
- "center": true,
- "color": "string",
- "fontFamily": "string",
- "fontSize": 0,
- "text": "string"
}, - "shape": "string",
- "size": 0,
- "color": "string",
- "fade": true,
- "data": {
- "property1": { },
- "property2": { }
}, - "glyphs": [
- {
- "angle": 0,
- "blink": true,
- "border": {
- "color": "string"
}, - "color": "string",
- "fontIcon": {
- "color": "string",
- "fontFamily": "string",
- "text": "string"
}, - "image": "string",
- "label": {
- "bold": true,
- "color": "string",
- "fontFamily": "string",
- "text": "string"
}, - "position": "string",
- "radius": 0,
- "size": 0
}
]
}
}Get info and counts for this GPO node.
| object_id required | string (object-id) The object id of the entity being operated on. |
| counts | boolean Default: true Include counts of related entities. Default value is |
| Prefer | integer [ 0 .. 60 ] Default: 30 Prefer header, used to specify a custom timeout in seconds using the wait parameter as per RFC7240. The default timeout is 30 seconds and maximum timeout is 60 seconds |
{- "data": {
- "props": {
- "property1": { },
- "property2": { }
}, - "property1": 0,
- "property2": 0
}
}Get a list, graph, or count of the computers affected by this GPO.
| object_id required | string (object-id) The object id of the entity being operated on. |
| skip | integer >= 0 Default: 0 The number of entries to skip for pagination. Only available for |
| limit | integer >= 0 Default: 10 The number of entries to limit in the response. Only available for |
| type | string Default: "list" Enum: "list" "graph" "count" The type of return data requested. If no type is provided, query will default to |
| sort_by | string (sort-by) Sort by column. Can be used multiple times; prepend a hyphen for descending order. Columns available for sorting are dependent on the entity object kind. |
| Prefer | integer [ 0 .. 60 ] Default: 30 Prefer header, used to specify a custom timeout in seconds using the wait parameter as per RFC7240. The default timeout is 30 seconds and maximum timeout is 60 seconds |
{- "property1": {
- "border": {
- "color": "string",
- "lineStyle": "string",
- "width": 0
}, - "coordinates": {
- "lat": 0,
- "lng": 0
}, - "cutout": true,
- "fontIcon": {
- "color": "string",
- "fontFamily": "string",
- "text": "string"
}, - "halos": [
- {
- "color": "string",
- "radius": 0,
- "width": 0
}
], - "image": "string",
- "label": {
- "backgroundColor": "string",
- "bold": true,
- "center": true,
- "color": "string",
- "fontFamily": "string",
- "fontSize": 0,
- "text": "string"
}, - "shape": "string",
- "size": 0,
- "color": "string",
- "fade": true,
- "data": {
- "property1": { },
- "property2": { }
}, - "glyphs": [
- {
- "angle": 0,
- "blink": true,
- "border": {
- "color": "string"
}, - "color": "string",
- "fontIcon": {
- "color": "string",
- "fontFamily": "string",
- "text": "string"
}, - "image": "string",
- "label": {
- "bold": true,
- "color": "string",
- "fontFamily": "string",
- "text": "string"
}, - "position": "string",
- "radius": 0,
- "size": 0
}
]
}, - "property2": {
- "border": {
- "color": "string",
- "lineStyle": "string",
- "width": 0
}, - "coordinates": {
- "lat": 0,
- "lng": 0
}, - "cutout": true,
- "fontIcon": {
- "color": "string",
- "fontFamily": "string",
- "text": "string"
}, - "halos": [
- {
- "color": "string",
- "radius": 0,
- "width": 0
}
], - "image": "string",
- "label": {
- "backgroundColor": "string",
- "bold": true,
- "center": true,
- "color": "string",
- "fontFamily": "string",
- "fontSize": 0,
- "text": "string"
}, - "shape": "string",
- "size": 0,
- "color": "string",
- "fade": true,
- "data": {
- "property1": { },
- "property2": { }
}, - "glyphs": [
- {
- "angle": 0,
- "blink": true,
- "border": {
- "color": "string"
}, - "color": "string",
- "fontIcon": {
- "color": "string",
- "fontFamily": "string",
- "text": "string"
}, - "image": "string",
- "label": {
- "bold": true,
- "color": "string",
- "fontFamily": "string",
- "text": "string"
}, - "position": "string",
- "radius": 0,
- "size": 0
}
]
}
}Get a list, graph, or count of the principals that can control this OU.
| object_id required | string (object-id) The object id of the entity being operated on. |
| skip | integer >= 0 Default: 0 The number of entries to skip for pagination. Only available for |
| limit | integer >= 0 Default: 10 The number of entries to limit in the response. Only available for |
| type | string Default: "list" Enum: "list" "graph" "count" The type of return data requested. If no type is provided, query will default to |
| sort_by | string (sort-by) Sort by column. Can be used multiple times; prepend a hyphen for descending order. Columns available for sorting are dependent on the entity object kind. |
| Prefer | integer [ 0 .. 60 ] Default: 30 Prefer header, used to specify a custom timeout in seconds using the wait parameter as per RFC7240. The default timeout is 30 seconds and maximum timeout is 60 seconds |
{- "property1": {
- "border": {
- "color": "string",
- "lineStyle": "string",
- "width": 0
}, - "coordinates": {
- "lat": 0,
- "lng": 0
}, - "cutout": true,
- "fontIcon": {
- "color": "string",
- "fontFamily": "string",
- "text": "string"
}, - "halos": [
- {
- "color": "string",
- "radius": 0,
- "width": 0
}
], - "image": "string",
- "label": {
- "backgroundColor": "string",
- "bold": true,
- "center": true,
- "color": "string",
- "fontFamily": "string",
- "fontSize": 0,
- "text": "string"
}, - "shape": "string",
- "size": 0,
- "color": "string",
- "fade": true,
- "data": {
- "property1": { },
- "property2": { }
}, - "glyphs": [
- {
- "angle": 0,
- "blink": true,
- "border": {
- "color": "string"
}, - "color": "string",
- "fontIcon": {
- "color": "string",
- "fontFamily": "string",
- "text": "string"
}, - "image": "string",
- "label": {
- "bold": true,
- "color": "string",
- "fontFamily": "string",
- "text": "string"
}, - "position": "string",
- "radius": 0,
- "size": 0
}
]
}, - "property2": {
- "border": {
- "color": "string",
- "lineStyle": "string",
- "width": 0
}, - "coordinates": {
- "lat": 0,
- "lng": 0
}, - "cutout": true,
- "fontIcon": {
- "color": "string",
- "fontFamily": "string",
- "text": "string"
}, - "halos": [
- {
- "color": "string",
- "radius": 0,
- "width": 0
}
], - "image": "string",
- "label": {
- "backgroundColor": "string",
- "bold": true,
- "center": true,
- "color": "string",
- "fontFamily": "string",
- "fontSize": 0,
- "text": "string"
}, - "shape": "string",
- "size": 0,
- "color": "string",
- "fade": true,
- "data": {
- "property1": { },
- "property2": { }
}, - "glyphs": [
- {
- "angle": 0,
- "blink": true,
- "border": {
- "color": "string"
}, - "color": "string",
- "fontIcon": {
- "color": "string",
- "fontFamily": "string",
- "text": "string"
}, - "image": "string",
- "label": {
- "bold": true,
- "color": "string",
- "fontFamily": "string",
- "text": "string"
}, - "position": "string",
- "radius": 0,
- "size": 0
}
]
}
}Get a list, graph, or count of the OUs affected by this GPO.
| object_id required | string (object-id) The object id of the entity being operated on. |
| skip | integer >= 0 Default: 0 The number of entries to skip for pagination. Only available for |
| limit | integer >= 0 Default: 10 The number of entries to limit in the response. Only available for |
| type | string Default: "list" Enum: "list" "graph" "count" The type of return data requested. If no type is provided, query will default to |
| sort_by | string (sort-by) Sort by column. Can be used multiple times; prepend a hyphen for descending order. Columns available for sorting are dependent on the entity object kind. |
| Prefer | integer [ 0 .. 60 ] Default: 30 Prefer header, used to specify a custom timeout in seconds using the wait parameter as per RFC7240. The default timeout is 30 seconds and maximum timeout is 60 seconds |
{- "property1": {
- "border": {
- "color": "string",
- "lineStyle": "string",
- "width": 0
}, - "coordinates": {
- "lat": 0,
- "lng": 0
}, - "cutout": true,
- "fontIcon": {
- "color": "string",
- "fontFamily": "string",
- "text": "string"
}, - "halos": [
- {
- "color": "string",
- "radius": 0,
- "width": 0
}
], - "image": "string",
- "label": {
- "backgroundColor": "string",
- "bold": true,
- "center": true,
- "color": "string",
- "fontFamily": "string",
- "fontSize": 0,
- "text": "string"
}, - "shape": "string",
- "size": 0,
- "color": "string",
- "fade": true,
- "data": {
- "property1": { },
- "property2": { }
}, - "glyphs": [
- {
- "angle": 0,
- "blink": true,
- "border": {
- "color": "string"
}, - "color": "string",
- "fontIcon": {
- "color": "string",
- "fontFamily": "string",
- "text": "string"
}, - "image": "string",
- "label": {
- "bold": true,
- "color": "string",
- "fontFamily": "string",
- "text": "string"
}, - "position": "string",
- "radius": 0,
- "size": 0
}
]
}, - "property2": {
- "border": {
- "color": "string",
- "lineStyle": "string",
- "width": 0
}, - "coordinates": {
- "lat": 0,
- "lng": 0
}, - "cutout": true,
- "fontIcon": {
- "color": "string",
- "fontFamily": "string",
- "text": "string"
}, - "halos": [
- {
- "color": "string",
- "radius": 0,
- "width": 0
}
], - "image": "string",
- "label": {
- "backgroundColor": "string",
- "bold": true,
- "center": true,
- "color": "string",
- "fontFamily": "string",
- "fontSize": 0,
- "text": "string"
}, - "shape": "string",
- "size": 0,
- "color": "string",
- "fade": true,
- "data": {
- "property1": { },
- "property2": { }
}, - "glyphs": [
- {
- "angle": 0,
- "blink": true,
- "border": {
- "color": "string"
}, - "color": "string",
- "fontIcon": {
- "color": "string",
- "fontFamily": "string",
- "text": "string"
}, - "image": "string",
- "label": {
- "bold": true,
- "color": "string",
- "fontFamily": "string",
- "text": "string"
}, - "position": "string",
- "radius": 0,
- "size": 0
}
]
}
}Get a list, graph, or count of the tier-zero principals associated with this GPO.
| object_id required | string (object-id) The object id of the entity being operated on. |
| skip | integer >= 0 Default: 0 The number of entries to skip for pagination. Only available for |
| limit | integer >= 0 Default: 10 The number of entries to limit in the response. Only available for |
| type | string Default: "list" Enum: "list" "graph" "count" The type of return data requested. If no type is provided, query will default to |
| sort_by | string (sort-by) Sort by column. Can be used multiple times; prepend a hyphen for descending order. Columns available for sorting are dependent on the entity object kind. |
| Prefer | integer [ 0 .. 60 ] Default: 30 Prefer header, used to specify a custom timeout in seconds using the wait parameter as per RFC7240. The default timeout is 30 seconds and maximum timeout is 60 seconds |
{- "property1": {
- "border": {
- "color": "string",
- "lineStyle": "string",
- "width": 0
}, - "coordinates": {
- "lat": 0,
- "lng": 0
}, - "cutout": true,
- "fontIcon": {
- "color": "string",
- "fontFamily": "string",
- "text": "string"
}, - "halos": [
- {
- "color": "string",
- "radius": 0,
- "width": 0
}
], - "image": "string",
- "label": {
- "backgroundColor": "string",
- "bold": true,
- "center": true,
- "color": "string",
- "fontFamily": "string",
- "fontSize": 0,
- "text": "string"
}, - "shape": "string",
- "size": 0,
- "color": "string",
- "fade": true,
- "data": {
- "property1": { },
- "property2": { }
}, - "glyphs": [
- {
- "angle": 0,
- "blink": true,
- "border": {
- "color": "string"
}, - "color": "string",
- "fontIcon": {
- "color": "string",
- "fontFamily": "string",
- "text": "string"
}, - "image": "string",
- "label": {
- "bold": true,
- "color": "string",
- "fontFamily": "string",
- "text": "string"
}, - "position": "string",
- "radius": 0,
- "size": 0
}
]
}, - "property2": {
- "border": {
- "color": "string",
- "lineStyle": "string",
- "width": 0
}, - "coordinates": {
- "lat": 0,
- "lng": 0
}, - "cutout": true,
- "fontIcon": {
- "color": "string",
- "fontFamily": "string",
- "text": "string"
}, - "halos": [
- {
- "color": "string",
- "radius": 0,
- "width": 0
}
], - "image": "string",
- "label": {
- "backgroundColor": "string",
- "bold": true,
- "center": true,
- "color": "string",
- "fontFamily": "string",
- "fontSize": 0,
- "text": "string"
}, - "shape": "string",
- "size": 0,
- "color": "string",
- "fade": true,
- "data": {
- "property1": { },
- "property2": { }
}, - "glyphs": [
- {
- "angle": 0,
- "blink": true,
- "border": {
- "color": "string"
}, - "color": "string",
- "fontIcon": {
- "color": "string",
- "fontFamily": "string",
- "text": "string"
}, - "image": "string",
- "label": {
- "bold": true,
- "color": "string",
- "fontFamily": "string",
- "text": "string"
}, - "position": "string",
- "radius": 0,
- "size": 0
}
]
}
}Get a list, graph, or count of the users affected by this GPO.
| object_id required | string (object-id) The object id of the entity being operated on. |
| skip | integer >= 0 Default: 0 The number of entries to skip for pagination. Only available for |
| limit | integer >= 0 Default: 10 The number of entries to limit in the response. Only available for |
| type | string Default: "list" Enum: "list" "graph" "count" The type of return data requested. If no type is provided, query will default to |
| sort_by | string (sort-by) Sort by column. Can be used multiple times; prepend a hyphen for descending order. Columns available for sorting are dependent on the entity object kind. |
| Prefer | integer [ 0 .. 60 ] Default: 30 Prefer header, used to specify a custom timeout in seconds using the wait parameter as per RFC7240. The default timeout is 30 seconds and maximum timeout is 60 seconds |
{- "property1": {
- "border": {
- "color": "string",
- "lineStyle": "string",
- "width": 0
}, - "coordinates": {
- "lat": 0,
- "lng": 0
}, - "cutout": true,
- "fontIcon": {
- "color": "string",
- "fontFamily": "string",
- "text": "string"
}, - "halos": [
- {
- "color": "string",
- "radius": 0,
- "width": 0
}
], - "image": "string",
- "label": {
- "backgroundColor": "string",
- "bold": true,
- "center": true,
- "color": "string",
- "fontFamily": "string",
- "fontSize": 0,
- "text": "string"
}, - "shape": "string",
- "size": 0,
- "color": "string",
- "fade": true,
- "data": {
- "property1": { },
- "property2": { }
}, - "glyphs": [
- {
- "angle": 0,
- "blink": true,
- "border": {
- "color": "string"
}, - "color": "string",
- "fontIcon": {
- "color": "string",
- "fontFamily": "string",
- "text": "string"
}, - "image": "string",
- "label": {
- "bold": true,
- "color": "string",
- "fontFamily": "string",
- "text": "string"
}, - "position": "string",
- "radius": 0,
- "size": 0
}
]
}, - "property2": {
- "border": {
- "color": "string",
- "lineStyle": "string",
- "width": 0
}, - "coordinates": {
- "lat": 0,
- "lng": 0
}, - "cutout": true,
- "fontIcon": {
- "color": "string",
- "fontFamily": "string",
- "text": "string"
}, - "halos": [
- {
- "color": "string",
- "radius": 0,
- "width": 0
}
], - "image": "string",
- "label": {
- "backgroundColor": "string",
- "bold": true,
- "center": true,
- "color": "string",
- "fontFamily": "string",
- "fontSize": 0,
- "text": "string"
}, - "shape": "string",
- "size": 0,
- "color": "string",
- "fade": true,
- "data": {
- "property1": { },
- "property2": { }
}, - "glyphs": [
- {
- "angle": 0,
- "blink": true,
- "border": {
- "color": "string"
}, - "color": "string",
- "fontIcon": {
- "color": "string",
- "fontFamily": "string",
- "text": "string"
}, - "image": "string",
- "label": {
- "bold": true,
- "color": "string",
- "fontFamily": "string",
- "text": "string"
}, - "position": "string",
- "radius": 0,
- "size": 0
}
]
}
}Get info and counts for this AIA CA node.
| object_id required | string (object-id) The object id of the entity being operated on. |
| counts | boolean Default: true Include counts of related entities. Default value is |
| Prefer | integer [ 0 .. 60 ] Default: 30 Prefer header, used to specify a custom timeout in seconds using the wait parameter as per RFC7240. The default timeout is 30 seconds and maximum timeout is 60 seconds |
{- "data": {
- "props": {
- "property1": { },
- "property2": { }
}, - "property1": 0,
- "property2": 0
}
}Get a list, graph, or count of the principals that can control this AIA CA.
| object_id required | string (object-id) The object id of the entity being operated on. |
| skip | integer >= 0 Default: 0 The number of entries to skip for pagination. Only available for |
| limit | integer >= 0 Default: 10 The number of entries to limit in the response. Only available for |
| type | string Default: "list" Enum: "list" "graph" "count" The type of return data requested. If no type is provided, query will default to |
| sort_by | string (sort-by) Sort by column. Can be used multiple times; prepend a hyphen for descending order. Columns available for sorting are dependent on the entity object kind. |
| Prefer | integer [ 0 .. 60 ] Default: 30 Prefer header, used to specify a custom timeout in seconds using the wait parameter as per RFC7240. The default timeout is 30 seconds and maximum timeout is 60 seconds |
{- "property1": {
- "border": {
- "color": "string",
- "lineStyle": "string",
- "width": 0
}, - "coordinates": {
- "lat": 0,
- "lng": 0
}, - "cutout": true,
- "fontIcon": {
- "color": "string",
- "fontFamily": "string",
- "text": "string"
}, - "halos": [
- {
- "color": "string",
- "radius": 0,
- "width": 0
}
], - "image": "string",
- "label": {
- "backgroundColor": "string",
- "bold": true,
- "center": true,
- "color": "string",
- "fontFamily": "string",
- "fontSize": 0,
- "text": "string"
}, - "shape": "string",
- "size": 0,
- "color": "string",
- "fade": true,
- "data": {
- "property1": { },
- "property2": { }
}, - "glyphs": [
- {
- "angle": 0,
- "blink": true,
- "border": {
- "color": "string"
}, - "color": "string",
- "fontIcon": {
- "color": "string",
- "fontFamily": "string",
- "text": "string"
}, - "image": "string",
- "label": {
- "bold": true,
- "color": "string",
- "fontFamily": "string",
- "text": "string"
}, - "position": "string",
- "radius": 0,
- "size": 0
}
]
}, - "property2": {
- "border": {
- "color": "string",
- "lineStyle": "string",
- "width": 0
}, - "coordinates": {
- "lat": 0,
- "lng": 0
}, - "cutout": true,
- "fontIcon": {
- "color": "string",
- "fontFamily": "string",
- "text": "string"
}, - "halos": [
- {
- "color": "string",
- "radius": 0,
- "width": 0
}
], - "image": "string",
- "label": {
- "backgroundColor": "string",
- "bold": true,
- "center": true,
- "color": "string",
- "fontFamily": "string",
- "fontSize": 0,
- "text": "string"
}, - "shape": "string",
- "size": 0,
- "color": "string",
- "fade": true,
- "data": {
- "property1": { },
- "property2": { }
}, - "glyphs": [
- {
- "angle": 0,
- "blink": true,
- "border": {
- "color": "string"
}, - "color": "string",
- "fontIcon": {
- "color": "string",
- "fontFamily": "string",
- "text": "string"
}, - "image": "string",
- "label": {
- "bold": true,
- "color": "string",
- "fontFamily": "string",
- "text": "string"
}, - "position": "string",
- "radius": 0,
- "size": 0
}
]
}
}Get info and counts for this Root CA node.
| object_id required | string (object-id) The object id of the entity being operated on. |
| counts | boolean Default: true Include counts of related entities. Default value is |
| Prefer | integer [ 0 .. 60 ] Default: 30 Prefer header, used to specify a custom timeout in seconds using the wait parameter as per RFC7240. The default timeout is 30 seconds and maximum timeout is 60 seconds |
{- "data": {
- "props": {
- "property1": { },
- "property2": { }
}, - "property1": 0,
- "property2": 0
}
}Get a list, graph, or count of the principals that can control this Root CA.
| object_id required | string (object-id) The object id of the entity being operated on. |
| skip | integer >= 0 Default: 0 The number of entries to skip for pagination. Only available for |
| limit | integer >= 0 Default: 10 The number of entries to limit in the response. Only available for |
| type | string Default: "list" Enum: "list" "graph" "count" The type of return data requested. If no type is provided, query will default to |
| sort_by | string (sort-by) Sort by column. Can be used multiple times; prepend a hyphen for descending order. Columns available for sorting are dependent on the entity object kind. |
| Prefer | integer [ 0 .. 60 ] Default: 30 Prefer header, used to specify a custom timeout in seconds using the wait parameter as per RFC7240. The default timeout is 30 seconds and maximum timeout is 60 seconds |
{- "property1": {
- "border": {
- "color": "string",
- "lineStyle": "string",
- "width": 0
}, - "coordinates": {
- "lat": 0,
- "lng": 0
}, - "cutout": true,
- "fontIcon": {
- "color": "string",
- "fontFamily": "string",
- "text": "string"
}, - "halos": [
- {
- "color": "string",
- "radius": 0,
- "width": 0
}
], - "image": "string",
- "label": {
- "backgroundColor": "string",
- "bold": true,
- "center": true,
- "color": "string",
- "fontFamily": "string",
- "fontSize": 0,
- "text": "string"
}, - "shape": "string",
- "size": 0,
- "color": "string",
- "fade": true,
- "data": {
- "property1": { },
- "property2": { }
}, - "glyphs": [
- {
- "angle": 0,
- "blink": true,
- "border": {
- "color": "string"
}, - "color": "string",
- "fontIcon": {
- "color": "string",
- "fontFamily": "string",
- "text": "string"
}, - "image": "string",
- "label": {
- "bold": true,
- "color": "string",
- "fontFamily": "string",
- "text": "string"
}, - "position": "string",
- "radius": 0,
- "size": 0
}
]
}, - "property2": {
- "border": {
- "color": "string",
- "lineStyle": "string",
- "width": 0
}, - "coordinates": {
- "lat": 0,
- "lng": 0
}, - "cutout": true,
- "fontIcon": {
- "color": "string",
- "fontFamily": "string",
- "text": "string"
}, - "halos": [
- {
- "color": "string",
- "radius": 0,
- "width": 0
}
], - "image": "string",
- "label": {
- "backgroundColor": "string",
- "bold": true,
- "center": true,
- "color": "string",
- "fontFamily": "string",
- "fontSize": 0,
- "text": "string"
}, - "shape": "string",
- "size": 0,
- "color": "string",
- "fade": true,
- "data": {
- "property1": { },
- "property2": { }
}, - "glyphs": [
- {
- "angle": 0,
- "blink": true,
- "border": {
- "color": "string"
}, - "color": "string",
- "fontIcon": {
- "color": "string",
- "fontFamily": "string",
- "text": "string"
}, - "image": "string",
- "label": {
- "bold": true,
- "color": "string",
- "fontFamily": "string",
- "text": "string"
}, - "position": "string",
- "radius": 0,
- "size": 0
}
]
}
}Get info and counts for this Enterprise CA node.
| object_id required | string (object-id) The object id of the entity being operated on. |
| counts | boolean Default: true Include counts of related entities. Default value is |
| Prefer | integer [ 0 .. 60 ] Default: 30 Prefer header, used to specify a custom timeout in seconds using the wait parameter as per RFC7240. The default timeout is 30 seconds and maximum timeout is 60 seconds |
{- "data": {
- "props": {
- "property1": { },
- "property2": { }
}, - "property1": 0,
- "property2": 0
}
}Get a list, graph, or count of the principals that can control this Enterprise CA.
| object_id required | string (object-id) The object id of the entity being operated on. |
| skip | integer >= 0 Default: 0 The number of entries to skip for pagination. Only available for |
| limit | integer >= 0 Default: 10 The number of entries to limit in the response. Only available for |
| type | string Default: "list" Enum: "list" "graph" "count" The type of return data requested. If no type is provided, query will default to |
| sort_by | string (sort-by) Sort by column. Can be used multiple times; prepend a hyphen for descending order. Columns available for sorting are dependent on the entity object kind. |
| Prefer | integer [ 0 .. 60 ] Default: 30 Prefer header, used to specify a custom timeout in seconds using the wait parameter as per RFC7240. The default timeout is 30 seconds and maximum timeout is 60 seconds |
{- "property1": {
- "border": {
- "color": "string",
- "lineStyle": "string",
- "width": 0
}, - "coordinates": {
- "lat": 0,
- "lng": 0
}, - "cutout": true,
- "fontIcon": {
- "color": "string",
- "fontFamily": "string",
- "text": "string"
}, - "halos": [
- {
- "color": "string",
- "radius": 0,
- "width": 0
}
], - "image": "string",
- "label": {
- "backgroundColor": "string",
- "bold": true,
- "center": true,
- "color": "string",
- "fontFamily": "string",
- "fontSize": 0,
- "text": "string"
}, - "shape": "string",
- "size": 0,
- "color": "string",
- "fade": true,
- "data": {
- "property1": { },
- "property2": { }
}, - "glyphs": [
- {
- "angle": 0,
- "blink": true,
- "border": {
- "color": "string"
}, - "color": "string",
- "fontIcon": {
- "color": "string",
- "fontFamily": "string",
- "text": "string"
}, - "image": "string",
- "label": {
- "bold": true,
- "color": "string",
- "fontFamily": "string",
- "text": "string"
}, - "position": "string",
- "radius": 0,
- "size": 0
}
]
}, - "property2": {
- "border": {
- "color": "string",
- "lineStyle": "string",
- "width": 0
}, - "coordinates": {
- "lat": 0,
- "lng": 0
}, - "cutout": true,
- "fontIcon": {
- "color": "string",
- "fontFamily": "string",
- "text": "string"
}, - "halos": [
- {
- "color": "string",
- "radius": 0,
- "width": 0
}
], - "image": "string",
- "label": {
- "backgroundColor": "string",
- "bold": true,
- "center": true,
- "color": "string",
- "fontFamily": "string",
- "fontSize": 0,
- "text": "string"
}, - "shape": "string",
- "size": 0,
- "color": "string",
- "fade": true,
- "data": {
- "property1": { },
- "property2": { }
}, - "glyphs": [
- {
- "angle": 0,
- "blink": true,
- "border": {
- "color": "string"
}, - "color": "string",
- "fontIcon": {
- "color": "string",
- "fontFamily": "string",
- "text": "string"
}, - "image": "string",
- "label": {
- "bold": true,
- "color": "string",
- "fontFamily": "string",
- "text": "string"
}, - "position": "string",
- "radius": 0,
- "size": 0
}
]
}
}Get info and counts for this NT Auth Store node.
| object_id required | string (object-id) The object id of the entity being operated on. |
| counts | boolean Default: true Include counts of related entities. Default value is |
| Prefer | integer [ 0 .. 60 ] Default: 30 Prefer header, used to specify a custom timeout in seconds using the wait parameter as per RFC7240. The default timeout is 30 seconds and maximum timeout is 60 seconds |
{- "data": {
- "props": {
- "property1": { },
- "property2": { }
}, - "property1": 0,
- "property2": 0
}
}Get a list, graph, or count of the principals that can control this NT Auth Store.
| object_id required | string (object-id) The object id of the entity being operated on. |
| skip | integer >= 0 Default: 0 The number of entries to skip for pagination. Only available for |
| limit | integer >= 0 Default: 10 The number of entries to limit in the response. Only available for |
| type | string Default: "list" Enum: "list" "graph" "count" The type of return data requested. If no type is provided, query will default to |
| sort_by | string (sort-by) Sort by column. Can be used multiple times; prepend a hyphen for descending order. Columns available for sorting are dependent on the entity object kind. |
| Prefer | integer [ 0 .. 60 ] Default: 30 Prefer header, used to specify a custom timeout in seconds using the wait parameter as per RFC7240. The default timeout is 30 seconds and maximum timeout is 60 seconds |
{- "property1": {
- "border": {
- "color": "string",
- "lineStyle": "string",
- "width": 0
}, - "coordinates": {
- "lat": 0,
- "lng": 0
}, - "cutout": true,
- "fontIcon": {
- "color": "string",
- "fontFamily": "string",
- "text": "string"
}, - "halos": [
- {
- "color": "string",
- "radius": 0,
- "width": 0
}
], - "image": "string",
- "label": {
- "backgroundColor": "string",
- "bold": true,
- "center": true,
- "color": "string",
- "fontFamily": "string",
- "fontSize": 0,
- "text": "string"
}, - "shape": "string",
- "size": 0,
- "color": "string",
- "fade": true,
- "data": {
- "property1": { },
- "property2": { }
}, - "glyphs": [
- {
- "angle": 0,
- "blink": true,
- "border": {
- "color": "string"
}, - "color": "string",
- "fontIcon": {
- "color": "string",
- "fontFamily": "string",
- "text": "string"
}, - "image": "string",
- "label": {
- "bold": true,
- "color": "string",
- "fontFamily": "string",
- "text": "string"
}, - "position": "string",
- "radius": 0,
- "size": 0
}
]
}, - "property2": {
- "border": {
- "color": "string",
- "lineStyle": "string",
- "width": 0
}, - "coordinates": {
- "lat": 0,
- "lng": 0
}, - "cutout": true,
- "fontIcon": {
- "color": "string",
- "fontFamily": "string",
- "text": "string"
}, - "halos": [
- {
- "color": "string",
- "radius": 0,
- "width": 0
}
], - "image": "string",
- "label": {
- "backgroundColor": "string",
- "bold": true,
- "center": true,
- "color": "string",
- "fontFamily": "string",
- "fontSize": 0,
- "text": "string"
}, - "shape": "string",
- "size": 0,
- "color": "string",
- "fade": true,
- "data": {
- "property1": { },
- "property2": { }
}, - "glyphs": [
- {
- "angle": 0,
- "blink": true,
- "border": {
- "color": "string"
}, - "color": "string",
- "fontIcon": {
- "color": "string",
- "fontFamily": "string",
- "text": "string"
}, - "image": "string",
- "label": {
- "bold": true,
- "color": "string",
- "fontFamily": "string",
- "text": "string"
}, - "position": "string",
- "radius": 0,
- "size": 0
}
]
}
}Get info and counts for this Cert Template node.
| object_id required | string (object-id) The object id of the entity being operated on. |
| counts | boolean Default: true Include counts of related entities. Default value is |
| Prefer | integer [ 0 .. 60 ] Default: 30 Prefer header, used to specify a custom timeout in seconds using the wait parameter as per RFC7240. The default timeout is 30 seconds and maximum timeout is 60 seconds |
{- "data": {
- "props": {
- "property1": { },
- "property2": { }
}, - "property1": 0,
- "property2": 0
}
}Get a list, graph, or count of the principals that can control this Cert Template.
| object_id required | string (object-id) The object id of the entity being operated on. |
| skip | integer >= 0 Default: 0 The number of entries to skip for pagination. Only available for |
| limit | integer >= 0 Default: 10 The number of entries to limit in the response. Only available for |
| type | string Default: "list" Enum: "list" "graph" "count" The type of return data requested. If no type is provided, query will default to |
| sort_by | string (sort-by) Sort by column. Can be used multiple times; prepend a hyphen for descending order. Columns available for sorting are dependent on the entity object kind. |
| Prefer | integer [ 0 .. 60 ] Default: 30 Prefer header, used to specify a custom timeout in seconds using the wait parameter as per RFC7240. The default timeout is 30 seconds and maximum timeout is 60 seconds |
{- "property1": {
- "border": {
- "color": "string",
- "lineStyle": "string",
- "width": 0
}, - "coordinates": {
- "lat": 0,
- "lng": 0
}, - "cutout": true,
- "fontIcon": {
- "color": "string",
- "fontFamily": "string",
- "text": "string"
}, - "halos": [
- {
- "color": "string",
- "radius": 0,
- "width": 0
}
], - "image": "string",
- "label": {
- "backgroundColor": "string",
- "bold": true,
- "center": true,
- "color": "string",
- "fontFamily": "string",
- "fontSize": 0,
- "text": "string"
}, - "shape": "string",
- "size": 0,
- "color": "string",
- "fade": true,
- "data": {
- "property1": { },
- "property2": { }
}, - "glyphs": [
- {
- "angle": 0,
- "blink": true,
- "border": {
- "color": "string"
}, - "color": "string",
- "fontIcon": {
- "color": "string",
- "fontFamily": "string",
- "text": "string"
}, - "image": "string",
- "label": {
- "bold": true,
- "color": "string",
- "fontFamily": "string",
- "text": "string"
}, - "position": "string",
- "radius": 0,
- "size": 0
}
]
}, - "property2": {
- "border": {
- "color": "string",
- "lineStyle": "string",
- "width": 0
}, - "coordinates": {
- "lat": 0,
- "lng": 0
}, - "cutout": true,
- "fontIcon": {
- "color": "string",
- "fontFamily": "string",
- "text": "string"
}, - "halos": [
- {
- "color": "string",
- "radius": 0,
- "width": 0
}
], - "image": "string",
- "label": {
- "backgroundColor": "string",
- "bold": true,
- "center": true,
- "color": "string",
- "fontFamily": "string",
- "fontSize": 0,
- "text": "string"
}, - "shape": "string",
- "size": 0,
- "color": "string",
- "fade": true,
- "data": {
- "property1": { },
- "property2": { }
}, - "glyphs": [
- {
- "angle": 0,
- "blink": true,
- "border": {
- "color": "string"
}, - "color": "string",
- "fontIcon": {
- "color": "string",
- "fontFamily": "string",
- "text": "string"
}, - "image": "string",
- "label": {
- "bold": true,
- "color": "string",
- "fontFamily": "string",
- "text": "string"
}, - "position": "string",
- "radius": 0,
- "size": 0
}
]
}
}Get info and counts for this OU node.
| object_id required | string (object-id) The object id of the entity being operated on. |
| counts | boolean Default: true Include counts of related entities. Default value is |
| Prefer | integer [ 0 .. 60 ] Default: 30 Prefer header, used to specify a custom timeout in seconds using the wait parameter as per RFC7240. The default timeout is 30 seconds and maximum timeout is 60 seconds |
{- "data": {
- "props": {
- "property1": { },
- "property2": { }
}, - "property1": 0,
- "property2": 0
}
}Get a list, graph, or count of the computers contained by this OU.
| object_id required | string (object-id) The object id of the entity being operated on. |
| skip | integer >= 0 Default: 0 The number of entries to skip for pagination. Only available for |
| limit | integer >= 0 Default: 10 The number of entries to limit in the response. Only available for |
| type | string Default: "list" Enum: "list" "graph" "count" The type of return data requested. If no type is provided, query will default to |
| sort_by | string (sort-by) Sort by column. Can be used multiple times; prepend a hyphen for descending order. Columns available for sorting are dependent on the entity object kind. |
| Prefer | integer [ 0 .. 60 ] Default: 30 Prefer header, used to specify a custom timeout in seconds using the wait parameter as per RFC7240. The default timeout is 30 seconds and maximum timeout is 60 seconds |
{- "property1": {
- "border": {
- "color": "string",
- "lineStyle": "string",
- "width": 0
}, - "coordinates": {
- "lat": 0,
- "lng": 0
}, - "cutout": true,
- "fontIcon": {
- "color": "string",
- "fontFamily": "string",
- "text": "string"
}, - "halos": [
- {
- "color": "string",
- "radius": 0,
- "width": 0
}
], - "image": "string",
- "label": {
- "backgroundColor": "string",
- "bold": true,
- "center": true,
- "color": "string",
- "fontFamily": "string",
- "fontSize": 0,
- "text": "string"
}, - "shape": "string",
- "size": 0,
- "color": "string",
- "fade": true,
- "data": {
- "property1": { },
- "property2": { }
}, - "glyphs": [
- {
- "angle": 0,
- "blink": true,
- "border": {
- "color": "string"
}, - "color": "string",
- "fontIcon": {
- "color": "string",
- "fontFamily": "string",
- "text": "string"
}, - "image": "string",
- "label": {
- "bold": true,
- "color": "string",
- "fontFamily": "string",
- "text": "string"
}, - "position": "string",
- "radius": 0,
- "size": 0
}
]
}, - "property2": {
- "border": {
- "color": "string",
- "lineStyle": "string",
- "width": 0
}, - "coordinates": {
- "lat": 0,
- "lng": 0
}, - "cutout": true,
- "fontIcon": {
- "color": "string",
- "fontFamily": "string",
- "text": "string"
}, - "halos": [
- {
- "color": "string",
- "radius": 0,
- "width": 0
}
], - "image": "string",
- "label": {
- "backgroundColor": "string",
- "bold": true,
- "center": true,
- "color": "string",
- "fontFamily": "string",
- "fontSize": 0,
- "text": "string"
}, - "shape": "string",
- "size": 0,
- "color": "string",
- "fade": true,
- "data": {
- "property1": { },
- "property2": { }
}, - "glyphs": [
- {
- "angle": 0,
- "blink": true,
- "border": {
- "color": "string"
}, - "color": "string",
- "fontIcon": {
- "color": "string",
- "fontFamily": "string",
- "text": "string"
}, - "image": "string",
- "label": {
- "bold": true,
- "color": "string",
- "fontFamily": "string",
- "text": "string"
}, - "position": "string",
- "radius": 0,
- "size": 0
}
]
}
}Get a list, graph, or count of the GPOs that affect this OU.
| object_id required | string (object-id) The object id of the entity being operated on. |
| skip | integer >= 0 Default: 0 The number of entries to skip for pagination. Only available for |
| limit | integer >= 0 Default: 10 The number of entries to limit in the response. Only available for |
| type | string Default: "list" Enum: "list" "graph" "count" The type of return data requested. If no type is provided, query will default to |
| sort_by | string (sort-by) Sort by column. Can be used multiple times; prepend a hyphen for descending order. Columns available for sorting are dependent on the entity object kind. |
| Prefer | integer [ 0 .. 60 ] Default: 30 Prefer header, used to specify a custom timeout in seconds using the wait parameter as per RFC7240. The default timeout is 30 seconds and maximum timeout is 60 seconds |
{- "property1": {
- "border": {
- "color": "string",
- "lineStyle": "string",
- "width": 0
}, - "coordinates": {
- "lat": 0,
- "lng": 0
}, - "cutout": true,
- "fontIcon": {
- "color": "string",
- "fontFamily": "string",
- "text": "string"
}, - "halos": [
- {
- "color": "string",
- "radius": 0,
- "width": 0
}
], - "image": "string",
- "label": {
- "backgroundColor": "string",
- "bold": true,
- "center": true,
- "color": "string",
- "fontFamily": "string",
- "fontSize": 0,
- "text": "string"
}, - "shape": "string",
- "size": 0,
- "color": "string",
- "fade": true,
- "data": {
- "property1": { },
- "property2": { }
}, - "glyphs": [
- {
- "angle": 0,
- "blink": true,
- "border": {
- "color": "string"
}, - "color": "string",
- "fontIcon": {
- "color": "string",
- "fontFamily": "string",
- "text": "string"
}, - "image": "string",
- "label": {
- "bold": true,
- "color": "string",
- "fontFamily": "string",
- "text": "string"
}, - "position": "string",
- "radius": 0,
- "size": 0
}
]
}, - "property2": {
- "border": {
- "color": "string",
- "lineStyle": "string",
- "width": 0
}, - "coordinates": {
- "lat": 0,
- "lng": 0
}, - "cutout": true,
- "fontIcon": {
- "color": "string",
- "fontFamily": "string",
- "text": "string"
}, - "halos": [
- {
- "color": "string",
- "radius": 0,
- "width": 0
}
], - "image": "string",
- "label": {
- "backgroundColor": "string",
- "bold": true,
- "center": true,
- "color": "string",
- "fontFamily": "string",
- "fontSize": 0,
- "text": "string"
}, - "shape": "string",
- "size": 0,
- "color": "string",
- "fade": true,
- "data": {
- "property1": { },
- "property2": { }
}, - "glyphs": [
- {
- "angle": 0,
- "blink": true,
- "border": {
- "color": "string"
}, - "color": "string",
- "fontIcon": {
- "color": "string",
- "fontFamily": "string",
- "text": "string"
}, - "image": "string",
- "label": {
- "bold": true,
- "color": "string",
- "fontFamily": "string",
- "text": "string"
}, - "position": "string",
- "radius": 0,
- "size": 0
}
]
}
}Get a list, graph, or count of the groups contained by this OU.
| object_id required | string (object-id) The object id of the entity being operated on. |
| skip | integer >= 0 Default: 0 The number of entries to skip for pagination. Only available for |
| limit | integer >= 0 Default: 10 The number of entries to limit in the response. Only available for |
| type | string Default: "list" Enum: "list" "graph" "count" The type of return data requested. If no type is provided, query will default to |
| sort_by | string (sort-by) Sort by column. Can be used multiple times; prepend a hyphen for descending order. Columns available for sorting are dependent on the entity object kind. |
| Prefer | integer [ 0 .. 60 ] Default: 30 Prefer header, used to specify a custom timeout in seconds using the wait parameter as per RFC7240. The default timeout is 30 seconds and maximum timeout is 60 seconds |
{- "property1": {
- "border": {
- "color": "string",
- "lineStyle": "string",
- "width": 0
}, - "coordinates": {
- "lat": 0,
- "lng": 0
}, - "cutout": true,
- "fontIcon": {
- "color": "string",
- "fontFamily": "string",
- "text": "string"
}, - "halos": [
- {
- "color": "string",
- "radius": 0,
- "width": 0
}
], - "image": "string",
- "label": {
- "backgroundColor": "string",
- "bold": true,
- "center": true,
- "color": "string",
- "fontFamily": "string",
- "fontSize": 0,
- "text": "string"
}, - "shape": "string",
- "size": 0,
- "color": "string",
- "fade": true,
- "data": {
- "property1": { },
- "property2": { }
}, - "glyphs": [
- {
- "angle": 0,
- "blink": true,
- "border": {
- "color": "string"
}, - "color": "string",
- "fontIcon": {
- "color": "string",
- "fontFamily": "string",
- "text": "string"
}, - "image": "string",
- "label": {
- "bold": true,
- "color": "string",
- "fontFamily": "string",
- "text": "string"
}, - "position": "string",
- "radius": 0,
- "size": 0
}
]
}, - "property2": {
- "border": {
- "color": "string",
- "lineStyle": "string",
- "width": 0
}, - "coordinates": {
- "lat": 0,
- "lng": 0
}, - "cutout": true,
- "fontIcon": {
- "color": "string",
- "fontFamily": "string",
- "text": "string"
}, - "halos": [
- {
- "color": "string",
- "radius": 0,
- "width": 0
}
], - "image": "string",
- "label": {
- "backgroundColor": "string",
- "bold": true,
- "center": true,
- "color": "string",
- "fontFamily": "string",
- "fontSize": 0,
- "text": "string"
}, - "shape": "string",
- "size": 0,
- "color": "string",
- "fade": true,
- "data": {
- "property1": { },
- "property2": { }
}, - "glyphs": [
- {
- "angle": 0,
- "blink": true,
- "border": {
- "color": "string"
}, - "color": "string",
- "fontIcon": {
- "color": "string",
- "fontFamily": "string",
- "text": "string"
}, - "image": "string",
- "label": {
- "bold": true,
- "color": "string",
- "fontFamily": "string",
- "text": "string"
}, - "position": "string",
- "radius": 0,
- "size": 0
}
]
}
}Get a list, graph, or count of the users contained by this OU.
| object_id required | string (object-id) The object id of the entity being operated on. |
| skip | integer >= 0 Default: 0 The number of entries to skip for pagination. Only available for |
| limit | integer >= 0 Default: 10 The number of entries to limit in the response. Only available for |
| type | string Default: "list" Enum: "list" "graph" "count" The type of return data requested. If no type is provided, query will default to |
| sort_by | string (sort-by) Sort by column. Can be used multiple times; prepend a hyphen for descending order. Columns available for sorting are dependent on the entity object kind. |
| Prefer | integer [ 0 .. 60 ] Default: 30 Prefer header, used to specify a custom timeout in seconds using the wait parameter as per RFC7240. The default timeout is 30 seconds and maximum timeout is 60 seconds |
{- "property1": {
- "border": {
- "color": "string",
- "lineStyle": "string",
- "width": 0
}, - "coordinates": {
- "lat": 0,
- "lng": 0
}, - "cutout": true,
- "fontIcon": {
- "color": "string",
- "fontFamily": "string",
- "text": "string"
}, - "halos": [
- {
- "color": "string",
- "radius": 0,
- "width": 0
}
], - "image": "string",
- "label": {
- "backgroundColor": "string",
- "bold": true,
- "center": true,
- "color": "string",
- "fontFamily": "string",
- "fontSize": 0,
- "text": "string"
}, - "shape": "string",
- "size": 0,
- "color": "string",
- "fade": true,
- "data": {
- "property1": { },
- "property2": { }
}, - "glyphs": [
- {
- "angle": 0,
- "blink": true,
- "border": {
- "color": "string"
}, - "color": "string",
- "fontIcon": {
- "color": "string",
- "fontFamily": "string",
- "text": "string"
}, - "image": "string",
- "label": {
- "bold": true,
- "color": "string",
- "fontFamily": "string",
- "text": "string"
}, - "position": "string",
- "radius": 0,
- "size": 0
}
]
}, - "property2": {
- "border": {
- "color": "string",
- "lineStyle": "string",
- "width": 0
}, - "coordinates": {
- "lat": 0,
- "lng": 0
}, - "cutout": true,
- "fontIcon": {
- "color": "string",
- "fontFamily": "string",
- "text": "string"
}, - "halos": [
- {
- "color": "string",
- "radius": 0,
- "width": 0
}
], - "image": "string",
- "label": {
- "backgroundColor": "string",
- "bold": true,
- "center": true,
- "color": "string",
- "fontFamily": "string",
- "fontSize": 0,
- "text": "string"
}, - "shape": "string",
- "size": 0,
- "color": "string",
- "fade": true,
- "data": {
- "property1": { },
- "property2": { }
}, - "glyphs": [
- {
- "angle": 0,
- "blink": true,
- "border": {
- "color": "string"
}, - "color": "string",
- "fontIcon": {
- "color": "string",
- "fontFamily": "string",
- "text": "string"
}, - "image": "string",
- "label": {
- "bold": true,
- "color": "string",
- "fontFamily": "string",
- "text": "string"
}, - "position": "string",
- "radius": 0,
- "size": 0
}
]
}
}Get info and counts for this User node.
| object_id required | string (object-id) The object id of the entity being operated on. |
| counts | boolean Default: true Include counts of related entities. Default value is |
| Prefer | integer [ 0 .. 60 ] Default: 30 Prefer header, used to specify a custom timeout in seconds using the wait parameter as per RFC7240. The default timeout is 30 seconds and maximum timeout is 60 seconds |
{- "data": {
- "props": {
- "property1": { },
- "property2": { }
}, - "property1": 0,
- "property2": 0
}
}Get a list, graph, or count of the systems this user has admin rights to.
| object_id required | string (object-id) The object id of the entity being operated on. |
| skip | integer >= 0 Default: 0 The number of entries to skip for pagination. Only available for |
| limit | integer >= 0 Default: 10 The number of entries to limit in the response. Only available for |
| type | string Default: "list" Enum: "list" "graph" "count" The type of return data requested. If no type is provided, query will default to |
| sort_by | string (sort-by) Sort by column. Can be used multiple times; prepend a hyphen for descending order. Columns available for sorting are dependent on the entity object kind. |
| Prefer | integer [ 0 .. 60 ] Default: 30 Prefer header, used to specify a custom timeout in seconds using the wait parameter as per RFC7240. The default timeout is 30 seconds and maximum timeout is 60 seconds |
{- "property1": {
- "border": {
- "color": "string",
- "lineStyle": "string",
- "width": 0
}, - "coordinates": {
- "lat": 0,
- "lng": 0
}, - "cutout": true,
- "fontIcon": {
- "color": "string",
- "fontFamily": "string",
- "text": "string"
}, - "halos": [
- {
- "color": "string",
- "radius": 0,
- "width": 0
}
], - "image": "string",
- "label": {
- "backgroundColor": "string",
- "bold": true,
- "center": true,
- "color": "string",
- "fontFamily": "string",
- "fontSize": 0,
- "text": "string"
}, - "shape": "string",
- "size": 0,
- "color": "string",
- "fade": true,
- "data": {
- "property1": { },
- "property2": { }
}, - "glyphs": [
- {
- "angle": 0,
- "blink": true,
- "border": {
- "color": "string"
}, - "color": "string",
- "fontIcon": {
- "color": "string",
- "fontFamily": "string",
- "text": "string"
}, - "image": "string",
- "label": {
- "bold": true,
- "color": "string",
- "fontFamily": "string",
- "text": "string"
}, - "position": "string",
- "radius": 0,
- "size": 0
}
]
}, - "property2": {
- "border": {
- "color": "string",
- "lineStyle": "string",
- "width": 0
}, - "coordinates": {
- "lat": 0,
- "lng": 0
}, - "cutout": true,
- "fontIcon": {
- "color": "string",
- "fontFamily": "string",
- "text": "string"
}, - "halos": [
- {
- "color": "string",
- "radius": 0,
- "width": 0
}
], - "image": "string",
- "label": {
- "backgroundColor": "string",
- "bold": true,
- "center": true,
- "color": "string",
- "fontFamily": "string",
- "fontSize": 0,
- "text": "string"
}, - "shape": "string",
- "size": 0,
- "color": "string",
- "fade": true,
- "data": {
- "property1": { },
- "property2": { }
}, - "glyphs": [
- {
- "angle": 0,
- "blink": true,
- "border": {
- "color": "string"
}, - "color": "string",
- "fontIcon": {
- "color": "string",
- "fontFamily": "string",
- "text": "string"
}, - "image": "string",
- "label": {
- "bold": true,
- "color": "string",
- "fontFamily": "string",
- "text": "string"
}, - "position": "string",
- "radius": 0,
- "size": 0
}
]
}
}Get a list, graph, or count of the systems this user has constrained delegation rights to.
| object_id required | string (object-id) The object id of the entity being operated on. |
| skip | integer >= 0 Default: 0 The number of entries to skip for pagination. Only available for |
| limit | integer >= 0 Default: 10 The number of entries to limit in the response. Only available for |
| type | string Default: "list" Enum: "list" "graph" "count" The type of return data requested. If no type is provided, query will default to |
| sort_by | string (sort-by) Sort by column. Can be used multiple times; prepend a hyphen for descending order. Columns available for sorting are dependent on the entity object kind. |
| Prefer | integer [ 0 .. 60 ] Default: 30 Prefer header, used to specify a custom timeout in seconds using the wait parameter as per RFC7240. The default timeout is 30 seconds and maximum timeout is 60 seconds |
{- "property1": {
- "border": {
- "color": "string",
- "lineStyle": "string",
- "width": 0
}, - "coordinates": {
- "lat": 0,
- "lng": 0
}, - "cutout": true,
- "fontIcon": {
- "color": "string",
- "fontFamily": "string",
- "text": "string"
}, - "halos": [
- {
- "color": "string",
- "radius": 0,
- "width": 0
}
], - "image": "string",
- "label": {
- "backgroundColor": "string",
- "bold": true,
- "center": true,
- "color": "string",
- "fontFamily": "string",
- "fontSize": 0,
- "text": "string"
}, - "shape": "string",
- "size": 0,
- "color": "string",
- "fade": true,
- "data": {
- "property1": { },
- "property2": { }
}, - "glyphs": [
- {
- "angle": 0,
- "blink": true,
- "border": {
- "color": "string"
}, - "color": "string",
- "fontIcon": {
- "color": "string",
- "fontFamily": "string",
- "text": "string"
}, - "image": "string",
- "label": {
- "bold": true,
- "color": "string",
- "fontFamily": "string",
- "text": "string"
}, - "position": "string",
- "radius": 0,
- "size": 0
}
]
}, - "property2": {
- "border": {
- "color": "string",
- "lineStyle": "string",
- "width": 0
}, - "coordinates": {
- "lat": 0,
- "lng": 0
}, - "cutout": true,
- "fontIcon": {
- "color": "string",
- "fontFamily": "string",
- "text": "string"
}, - "halos": [
- {
- "color": "string",
- "radius": 0,
- "width": 0
}
], - "image": "string",
- "label": {
- "backgroundColor": "string",
- "bold": true,
- "center": true,
- "color": "string",
- "fontFamily": "string",
- "fontSize": 0,
- "text": "string"
}, - "shape": "string",
- "size": 0,
- "color": "string",
- "fade": true,
- "data": {
- "property1": { },
- "property2": { }
}, - "glyphs": [
- {
- "angle": 0,
- "blink": true,
- "border": {
- "color": "string"
}, - "color": "string",
- "fontIcon": {
- "color": "string",
- "fontFamily": "string",
- "text": "string"
}, - "image": "string",
- "label": {
- "bold": true,
- "color": "string",
- "fontFamily": "string",
- "text": "string"
}, - "position": "string",
- "radius": 0,
- "size": 0
}
]
}
}Get a list, graph, or count of the principals this user can control.
| object_id required | string (object-id) The object id of the entity being operated on. |
| skip | integer >= 0 Default: 0 The number of entries to skip for pagination. Only available for |
| limit | integer >= 0 Default: 10 The number of entries to limit in the response. Only available for |
| type | string Default: "list" Enum: "list" "graph" "count" The type of return data requested. If no type is provided, query will default to |
| sort_by | string (sort-by) Sort by column. Can be used multiple times; prepend a hyphen for descending order. Columns available for sorting are dependent on the entity object kind. |
| Prefer | integer [ 0 .. 60 ] Default: 30 Prefer header, used to specify a custom timeout in seconds using the wait parameter as per RFC7240. The default timeout is 30 seconds and maximum timeout is 60 seconds |
{- "property1": {
- "border": {
- "color": "string",
- "lineStyle": "string",
- "width": 0
}, - "coordinates": {
- "lat": 0,
- "lng": 0
}, - "cutout": true,
- "fontIcon": {
- "color": "string",
- "fontFamily": "string",
- "text": "string"
}, - "halos": [
- {
- "color": "string",
- "radius": 0,
- "width": 0
}
], - "image": "string",
- "label": {
- "backgroundColor": "string",
- "bold": true,
- "center": true,
- "color": "string",
- "fontFamily": "string",
- "fontSize": 0,
- "text": "string"
}, - "shape": "string",
- "size": 0,
- "color": "string",
- "fade": true,
- "data": {
- "property1": { },
- "property2": { }
}, - "glyphs": [
- {
- "angle": 0,
- "blink": true,
- "border": {
- "color": "string"
}, - "color": "string",
- "fontIcon": {
- "color": "string",
- "fontFamily": "string",
- "text": "string"
}, - "image": "string",
- "label": {
- "bold": true,
- "color": "string",
- "fontFamily": "string",
- "text": "string"
}, - "position": "string",
- "radius": 0,
- "size": 0
}
]
}, - "property2": {
- "border": {
- "color": "string",
- "lineStyle": "string",
- "width": 0
}, - "coordinates": {
- "lat": 0,
- "lng": 0
}, - "cutout": true,
- "fontIcon": {
- "color": "string",
- "fontFamily": "string",
- "text": "string"
}, - "halos": [
- {
- "color": "string",
- "radius": 0,
- "width": 0
}
], - "image": "string",
- "label": {
- "backgroundColor": "string",
- "bold": true,
- "center": true,
- "color": "string",
- "fontFamily": "string",
- "fontSize": 0,
- "text": "string"
}, - "shape": "string",
- "size": 0,
- "color": "string",
- "fade": true,
- "data": {
- "property1": { },
- "property2": { }
}, - "glyphs": [
- {
- "angle": 0,
- "blink": true,
- "border": {
- "color": "string"
}, - "color": "string",
- "fontIcon": {
- "color": "string",
- "fontFamily": "string",
- "text": "string"
}, - "image": "string",
- "label": {
- "bold": true,
- "color": "string",
- "fontFamily": "string",
- "text": "string"
}, - "position": "string",
- "radius": 0,
- "size": 0
}
]
}
}Get a list, graph, or count of the principals that can control this User.
| object_id required | string (object-id) The object id of the entity being operated on. |
| skip | integer >= 0 Default: 0 The number of entries to skip for pagination. Only available for |
| limit | integer >= 0 Default: 10 The number of entries to limit in the response. Only available for |
| type | string Default: "list" Enum: "list" "graph" "count" The type of return data requested. If no type is provided, query will default to |
| sort_by | string (sort-by) Sort by column. Can be used multiple times; prepend a hyphen for descending order. Columns available for sorting are dependent on the entity object kind. |
| Prefer | integer [ 0 .. 60 ] Default: 30 Prefer header, used to specify a custom timeout in seconds using the wait parameter as per RFC7240. The default timeout is 30 seconds and maximum timeout is 60 seconds |
{- "property1": {
- "border": {
- "color": "string",
- "lineStyle": "string",
- "width": 0
}, - "coordinates": {
- "lat": 0,
- "lng": 0
}, - "cutout": true,
- "fontIcon": {
- "color": "string",
- "fontFamily": "string",
- "text": "string"
}, - "halos": [
- {
- "color": "string",
- "radius": 0,
- "width": 0
}
], - "image": "string",
- "label": {
- "backgroundColor": "string",
- "bold": true,
- "center": true,
- "color": "string",
- "fontFamily": "string",
- "fontSize": 0,
- "text": "string"
}, - "shape": "string",
- "size": 0,
- "color": "string",
- "fade": true,
- "data": {
- "property1": { },
- "property2": { }
}, - "glyphs": [
- {
- "angle": 0,
- "blink": true,
- "border": {
- "color": "string"
}, - "color": "string",
- "fontIcon": {
- "color": "string",
- "fontFamily": "string",
- "text": "string"
}, - "image": "string",
- "label": {
- "bold": true,
- "color": "string",
- "fontFamily": "string",
- "text": "string"
}, - "position": "string",
- "radius": 0,
- "size": 0
}
]
}, - "property2": {
- "border": {
- "color": "string",
- "lineStyle": "string",
- "width": 0
}, - "coordinates": {
- "lat": 0,
- "lng": 0
}, - "cutout": true,
- "fontIcon": {
- "color": "string",
- "fontFamily": "string",
- "text": "string"
}, - "halos": [
- {
- "color": "string",
- "radius": 0,
- "width": 0
}
], - "image": "string",
- "label": {
- "backgroundColor": "string",
- "bold": true,
- "center": true,
- "color": "string",
- "fontFamily": "string",
- "fontSize": 0,
- "text": "string"
}, - "shape": "string",
- "size": 0,
- "color": "string",
- "fade": true,
- "data": {
- "property1": { },
- "property2": { }
}, - "glyphs": [
- {
- "angle": 0,
- "blink": true,
- "border": {
- "color": "string"
}, - "color": "string",
- "fontIcon": {
- "color": "string",
- "fontFamily": "string",
- "text": "string"
}, - "image": "string",
- "label": {
- "bold": true,
- "color": "string",
- "fontFamily": "string",
- "text": "string"
}, - "position": "string",
- "radius": 0,
- "size": 0
}
]
}
}Get a list, graph, or count of the systems this user can execute DCOM on.
| object_id required | string (object-id) The object id of the entity being operated on. |
| skip | integer >= 0 Default: 0 The number of entries to skip for pagination. Only available for |
| limit | integer >= 0 Default: 10 The number of entries to limit in the response. Only available for |
| type | string Default: "list" Enum: "list" "graph" "count" The type of return data requested. If no type is provided, query will default to |
| sort_by | string (sort-by) Sort by column. Can be used multiple times; prepend a hyphen for descending order. Columns available for sorting are dependent on the entity object kind. |
| Prefer | integer [ 0 .. 60 ] Default: 30 Prefer header, used to specify a custom timeout in seconds using the wait parameter as per RFC7240. The default timeout is 30 seconds and maximum timeout is 60 seconds |
{- "property1": {
- "border": {
- "color": "string",
- "lineStyle": "string",
- "width": 0
}, - "coordinates": {
- "lat": 0,
- "lng": 0
}, - "cutout": true,
- "fontIcon": {
- "color": "string",
- "fontFamily": "string",
- "text": "string"
}, - "halos": [
- {
- "color": "string",
- "radius": 0,
- "width": 0
}
], - "image": "string",
- "label": {
- "backgroundColor": "string",
- "bold": true,
- "center": true,
- "color": "string",
- "fontFamily": "string",
- "fontSize": 0,
- "text": "string"
}, - "shape": "string",
- "size": 0,
- "color": "string",
- "fade": true,
- "data": {
- "property1": { },
- "property2": { }
}, - "glyphs": [
- {
- "angle": 0,
- "blink": true,
- "border": {
- "color": "string"
}, - "color": "string",
- "fontIcon": {
- "color": "string",
- "fontFamily": "string",
- "text": "string"
}, - "image": "string",
- "label": {
- "bold": true,
- "color": "string",
- "fontFamily": "string",
- "text": "string"
}, - "position": "string",
- "radius": 0,
- "size": 0
}
]
}, - "property2": {
- "border": {
- "color": "string",
- "lineStyle": "string",
- "width": 0
}, - "coordinates": {
- "lat": 0,
- "lng": 0
}, - "cutout": true,
- "fontIcon": {
- "color": "string",
- "fontFamily": "string",
- "text": "string"
}, - "halos": [
- {
- "color": "string",
- "radius": 0,
- "width": 0
}
], - "image": "string",
- "label": {
- "backgroundColor": "string",
- "bold": true,
- "center": true,
- "color": "string",
- "fontFamily": "string",
- "fontSize": 0,
- "text": "string"
}, - "shape": "string",
- "size": 0,
- "color": "string",
- "fade": true,
- "data": {
- "property1": { },
- "property2": { }
}, - "glyphs": [
- {
- "angle": 0,
- "blink": true,
- "border": {
- "color": "string"
}, - "color": "string",
- "fontIcon": {
- "color": "string",
- "fontFamily": "string",
- "text": "string"
}, - "image": "string",
- "label": {
- "bold": true,
- "color": "string",
- "fontFamily": "string",
- "text": "string"
}, - "position": "string",
- "radius": 0,
- "size": 0
}
]
}
}Get a list, graph, or count of the groups this user is a member of.
| object_id required | string (object-id) The object id of the entity being operated on. |
| skip | integer >= 0 Default: 0 The number of entries to skip for pagination. Only available for |
| limit | integer >= 0 Default: 10 The number of entries to limit in the response. Only available for |
| type | string Default: "list" Enum: "list" "graph" "count" The type of return data requested. If no type is provided, query will default to |
| sort_by | string (sort-by) Sort by column. Can be used multiple times; prepend a hyphen for descending order. Columns available for sorting are dependent on the entity object kind. |
| Prefer | integer [ 0 .. 60 ] Default: 30 Prefer header, used to specify a custom timeout in seconds using the wait parameter as per RFC7240. The default timeout is 30 seconds and maximum timeout is 60 seconds |
{- "property1": {
- "border": {
- "color": "string",
- "lineStyle": "string",
- "width": 0
}, - "coordinates": {
- "lat": 0,
- "lng": 0
}, - "cutout": true,
- "fontIcon": {
- "color": "string",
- "fontFamily": "string",
- "text": "string"
}, - "halos": [
- {
- "color": "string",
- "radius": 0,
- "width": 0
}
], - "image": "string",
- "label": {
- "backgroundColor": "string",
- "bold": true,
- "center": true,
- "color": "string",
- "fontFamily": "string",
- "fontSize": 0,
- "text": "string"
}, - "shape": "string",
- "size": 0,
- "color": "string",
- "fade": true,
- "data": {
- "property1": { },
- "property2": { }
}, - "glyphs": [
- {
- "angle": 0,
- "blink": true,
- "border": {
- "color": "string"
}, - "color": "string",
- "fontIcon": {
- "color": "string",
- "fontFamily": "string",
- "text": "string"
}, - "image": "string",
- "label": {
- "bold": true,
- "color": "string",
- "fontFamily": "string",
- "text": "string"
}, - "position": "string",
- "radius": 0,
- "size": 0
}
]
}, - "property2": {
- "border": {
- "color": "string",
- "lineStyle": "string",
- "width": 0
}, - "coordinates": {
- "lat": 0,
- "lng": 0
}, - "cutout": true,
- "fontIcon": {
- "color": "string",
- "fontFamily": "string",
- "text": "string"
}, - "halos": [
- {
- "color": "string",
- "radius": 0,
- "width": 0
}
], - "image": "string",
- "label": {
- "backgroundColor": "string",
- "bold": true,
- "center": true,
- "color": "string",
- "fontFamily": "string",
- "fontSize": 0,
- "text": "string"
}, - "shape": "string",
- "size": 0,
- "color": "string",
- "fade": true,
- "data": {
- "property1": { },
- "property2": { }
}, - "glyphs": [
- {
- "angle": 0,
- "blink": true,
- "border": {
- "color": "string"
}, - "color": "string",
- "fontIcon": {
- "color": "string",
- "fontFamily": "string",
- "text": "string"
}, - "image": "string",
- "label": {
- "bold": true,
- "color": "string",
- "fontFamily": "string",
- "text": "string"
}, - "position": "string",
- "radius": 0,
- "size": 0
}
]
}
}Get a list, graph, or count of the systems this user can execute PowerShell remote on.
| object_id required | string (object-id) The object id of the entity being operated on. |
| skip | integer >= 0 Default: 0 The number of entries to skip for pagination. Only available for |
| limit | integer >= 0 Default: 10 The number of entries to limit in the response. Only available for |
| type | string Default: "list" Enum: "list" "graph" "count" The type of return data requested. If no type is provided, query will default to |
| sort_by | string (sort-by) Sort by column. Can be used multiple times; prepend a hyphen for descending order. Columns available for sorting are dependent on the entity object kind. |
| Prefer | integer [ 0 .. 60 ] Default: 30 Prefer header, used to specify a custom timeout in seconds using the wait parameter as per RFC7240. The default timeout is 30 seconds and maximum timeout is 60 seconds |
{- "property1": {
- "border": {
- "color": "string",
- "lineStyle": "string",
- "width": 0
}, - "coordinates": {
- "lat": 0,
- "lng": 0
}, - "cutout": true,
- "fontIcon": {
- "color": "string",
- "fontFamily": "string",
- "text": "string"
}, - "halos": [
- {
- "color": "string",
- "radius": 0,
- "width": 0
}
], - "image": "string",
- "label": {
- "backgroundColor": "string",
- "bold": true,
- "center": true,
- "color": "string",
- "fontFamily": "string",
- "fontSize": 0,
- "text": "string"
}, - "shape": "string",
- "size": 0,
- "color": "string",
- "fade": true,
- "data": {
- "property1": { },
- "property2": { }
}, - "glyphs": [
- {
- "angle": 0,
- "blink": true,
- "border": {
- "color": "string"
}, - "color": "string",
- "fontIcon": {
- "color": "string",
- "fontFamily": "string",
- "text": "string"
}, - "image": "string",
- "label": {
- "bold": true,
- "color": "string",
- "fontFamily": "string",
- "text": "string"
}, - "position": "string",
- "radius": 0,
- "size": 0
}
]
}, - "property2": {
- "border": {
- "color": "string",
- "lineStyle": "string",
- "width": 0
}, - "coordinates": {
- "lat": 0,
- "lng": 0
}, - "cutout": true,
- "fontIcon": {
- "color": "string",
- "fontFamily": "string",
- "text": "string"
}, - "halos": [
- {
- "color": "string",
- "radius": 0,
- "width": 0
}
], - "image": "string",
- "label": {
- "backgroundColor": "string",
- "bold": true,
- "center": true,
- "color": "string",
- "fontFamily": "string",
- "fontSize": 0,
- "text": "string"
}, - "shape": "string",
- "size": 0,
- "color": "string",
- "fade": true,
- "data": {
- "property1": { },
- "property2": { }
}, - "glyphs": [
- {
- "angle": 0,
- "blink": true,
- "border": {
- "color": "string"
}, - "color": "string",
- "fontIcon": {
- "color": "string",
- "fontFamily": "string",
- "text": "string"
}, - "image": "string",
- "label": {
- "bold": true,
- "color": "string",
- "fontFamily": "string",
- "text": "string"
}, - "position": "string",
- "radius": 0,
- "size": 0
}
]
}
}Get a list, graph, or count of the systems this user has RDP rights to.
| object_id required | string (object-id) The object id of the entity being operated on. |
| skip | integer >= 0 Default: 0 The number of entries to skip for pagination. Only available for |
| limit | integer >= 0 Default: 10 The number of entries to limit in the response. Only available for |
| type | string Default: "list" Enum: "list" "graph" "count" The type of return data requested. If no type is provided, query will default to |
| sort_by | string (sort-by) Sort by column. Can be used multiple times; prepend a hyphen for descending order. Columns available for sorting are dependent on the entity object kind. |
| Prefer | integer [ 0 .. 60 ] Default: 30 Prefer header, used to specify a custom timeout in seconds using the wait parameter as per RFC7240. The default timeout is 30 seconds and maximum timeout is 60 seconds |
{- "property1": {
- "border": {
- "color": "string",
- "lineStyle": "string",
- "width": 0
}, - "coordinates": {
- "lat": 0,
- "lng": 0
}, - "cutout": true,
- "fontIcon": {
- "color": "string",
- "fontFamily": "string",
- "text": "string"
}, - "halos": [
- {
- "color": "string",
- "radius": 0,
- "width": 0
}
], - "image": "string",
- "label": {
- "backgroundColor": "string",
- "bold": true,
- "center": true,
- "color": "string",
- "fontFamily": "string",
- "fontSize": 0,
- "text": "string"
}, - "shape": "string",
- "size": 0,
- "color": "string",
- "fade": true,
- "data": {
- "property1": { },
- "property2": { }
}, - "glyphs": [
- {
- "angle": 0,
- "blink": true,
- "border": {
- "color": "string"
}, - "color": "string",
- "fontIcon": {
- "color": "string",
- "fontFamily": "string",
- "text": "string"
}, - "image": "string",
- "label": {
- "bold": true,
- "color": "string",
- "fontFamily": "string",
- "text": "string"
}, - "position": "string",
- "radius": 0,
- "size": 0
}
]
}, - "property2": {
- "border": {
- "color": "string",
- "lineStyle": "string",
- "width": 0
}, - "coordinates": {
- "lat": 0,
- "lng": 0
}, - "cutout": true,
- "fontIcon": {
- "color": "string",
- "fontFamily": "string",
- "text": "string"
}, - "halos": [
- {
- "color": "string",
- "radius": 0,
- "width": 0
}
], - "image": "string",
- "label": {
- "backgroundColor": "string",
- "bold": true,
- "center": true,
- "color": "string",
- "fontFamily": "string",
- "fontSize": 0,
- "text": "string"
}, - "shape": "string",
- "size": 0,
- "color": "string",
- "fade": true,
- "data": {
- "property1": { },
- "property2": { }
}, - "glyphs": [
- {
- "angle": 0,
- "blink": true,
- "border": {
- "color": "string"
}, - "color": "string",
- "fontIcon": {
- "color": "string",
- "fontFamily": "string",
- "text": "string"
}, - "image": "string",
- "label": {
- "bold": true,
- "color": "string",
- "fontFamily": "string",
- "text": "string"
}, - "position": "string",
- "radius": 0,
- "size": 0
}
]
}
}Get a list, graph, or count of the systems this user has an active session on.
| object_id required | string (object-id) The object id of the entity being operated on. |
| skip | integer >= 0 Default: 0 The number of entries to skip for pagination. Only available for |
| limit | integer >= 0 Default: 10 The number of entries to limit in the response. Only available for |
| type | string Default: "list" Enum: "list" "graph" "count" The type of return data requested. If no type is provided, query will default to |
| sort_by | string (sort-by) Sort by column. Can be used multiple times; prepend a hyphen for descending order. Columns available for sorting are dependent on the entity object kind. |
| Prefer | integer [ 0 .. 60 ] Default: 30 Prefer header, used to specify a custom timeout in seconds using the wait parameter as per RFC7240. The default timeout is 30 seconds and maximum timeout is 60 seconds |
{- "property1": {
- "border": {
- "color": "string",
- "lineStyle": "string",
- "width": 0
}, - "coordinates": {
- "lat": 0,
- "lng": 0
}, - "cutout": true,
- "fontIcon": {
- "color": "string",
- "fontFamily": "string",
- "text": "string"
}, - "halos": [
- {
- "color": "string",
- "radius": 0,
- "width": 0
}
], - "image": "string",
- "label": {
- "backgroundColor": "string",
- "bold": true,
- "center": true,
- "color": "string",
- "fontFamily": "string",
- "fontSize": 0,
- "text": "string"
}, - "shape": "string",
- "size": 0,
- "color": "string",
- "fade": true,
- "data": {
- "property1": { },
- "property2": { }
}, - "glyphs": [
- {
- "angle": 0,
- "blink": true,
- "border": {
- "color": "string"
}, - "color": "string",
- "fontIcon": {
- "color": "string",
- "fontFamily": "string",
- "text": "string"
}, - "image": "string",
- "label": {
- "bold": true,
- "color": "string",
- "fontFamily": "string",
- "text": "string"
}, - "position": "string",
- "radius": 0,
- "size": 0
}
]
}, - "property2": {
- "border": {
- "color": "string",
- "lineStyle": "string",
- "width": 0
}, - "coordinates": {
- "lat": 0,
- "lng": 0
}, - "cutout": true,
- "fontIcon": {
- "color": "string",
- "fontFamily": "string",
- "text": "string"
}, - "halos": [
- {
- "color": "string",
- "radius": 0,
- "width": 0
}
], - "image": "string",
- "label": {
- "backgroundColor": "string",
- "bold": true,
- "center": true,
- "color": "string",
- "fontFamily": "string",
- "fontSize": 0,
- "text": "string"
}, - "shape": "string",
- "size": 0,
- "color": "string",
- "fade": true,
- "data": {
- "property1": { },
- "property2": { }
}, - "glyphs": [
- {
- "angle": 0,
- "blink": true,
- "border": {
- "color": "string"
}, - "color": "string",
- "fontIcon": {
- "color": "string",
- "fontFamily": "string",
- "text": "string"
}, - "image": "string",
- "label": {
- "bold": true,
- "color": "string",
- "fontFamily": "string",
- "text": "string"
}, - "position": "string",
- "radius": 0,
- "size": 0
}
]
}
}Get a list, graph, or count of the systems this user has SQL admin rights to.
| object_id required | string (object-id) The object id of the entity being operated on. |
| skip | integer >= 0 Default: 0 The number of entries to skip for pagination. Only available for |
| limit | integer >= 0 Default: 10 The number of entries to limit in the response. Only available for |
| type | string Default: "list" Enum: "list" "graph" "count" The type of return data requested. If no type is provided, query will default to |
| sort_by | string (sort-by) Sort by column. Can be used multiple times; prepend a hyphen for descending order. Columns available for sorting are dependent on the entity object kind. |
| Prefer | integer [ 0 .. 60 ] Default: 30 Prefer header, used to specify a custom timeout in seconds using the wait parameter as per RFC7240. The default timeout is 30 seconds and maximum timeout is 60 seconds |
{- "property1": {
- "border": {
- "color": "string",
- "lineStyle": "string",
- "width": 0
}, - "coordinates": {
- "lat": 0,
- "lng": 0
}, - "cutout": true,
- "fontIcon": {
- "color": "string",
- "fontFamily": "string",
- "text": "string"
}, - "halos": [
- {
- "color": "string",
- "radius": 0,
- "width": 0
}
], - "image": "string",
- "label": {
- "backgroundColor": "string",
- "bold": true,
- "center": true,
- "color": "string",
- "fontFamily": "string",
- "fontSize": 0,
- "text": "string"
}, - "shape": "string",
- "size": 0,
- "color": "string",
- "fade": true,
- "data": {
- "property1": { },
- "property2": { }
}, - "glyphs": [
- {
- "angle": 0,
- "blink": true,
- "border": {
- "color": "string"
}, - "color": "string",
- "fontIcon": {
- "color": "string",
- "fontFamily": "string",
- "text": "string"
}, - "image": "string",
- "label": {
- "bold": true,
- "color": "string",
- "fontFamily": "string",
- "text": "string"
}, - "position": "string",
- "radius": 0,
- "size": 0
}
]
}, - "property2": {
- "border": {
- "color": "string",
- "lineStyle": "string",
- "width": 0
}, - "coordinates": {
- "lat": 0,
- "lng": 0
}, - "cutout": true,
- "fontIcon": {
- "color": "string",
- "fontFamily": "string",
- "text": "string"
}, - "halos": [
- {
- "color": "string",
- "radius": 0,
- "width": 0
}
], - "image": "string",
- "label": {
- "backgroundColor": "string",
- "bold": true,
- "center": true,
- "color": "string",
- "fontFamily": "string",
- "fontSize": 0,
- "text": "string"
}, - "shape": "string",
- "size": 0,
- "color": "string",
- "fade": true,
- "data": {
- "property1": { },
- "property2": { }
}, - "glyphs": [
- {
- "angle": 0,
- "blink": true,
- "border": {
- "color": "string"
}, - "color": "string",
- "fontIcon": {
- "color": "string",
- "fontFamily": "string",
- "text": "string"
}, - "image": "string",
- "label": {
- "bold": true,
- "color": "string",
- "fontFamily": "string",
- "text": "string"
}, - "position": "string",
- "radius": 0,
- "size": 0
}
]
}
}Get info and counts for this Group node.
| object_id required | string (object-id) The object id of the entity being operated on. |
| counts | boolean Default: true Include counts of related entities. Default value is |
| Prefer | integer [ 0 .. 60 ] Default: 30 Prefer header, used to specify a custom timeout in seconds using the wait parameter as per RFC7240. The default timeout is 30 seconds and maximum timeout is 60 seconds |
{- "data": {
- "props": {
- "property1": { },
- "property2": { }
}, - "property1": 0,
- "property2": 0
}
}Get a list, graph, or count of the systems this group has admin rights to.
| object_id required | string (object-id) The object id of the entity being operated on. |
| skip | integer >= 0 Default: 0 The number of entries to skip for pagination. Only available for |
| limit | integer >= 0 Default: 10 The number of entries to limit in the response. Only available for |
| type | string Default: "list" Enum: "list" "graph" "count" The type of return data requested. If no type is provided, query will default to |
| sort_by | string (sort-by) Sort by column. Can be used multiple times; prepend a hyphen for descending order. Columns available for sorting are dependent on the entity object kind. |
| Prefer | integer [ 0 .. 60 ] Default: 30 Prefer header, used to specify a custom timeout in seconds using the wait parameter as per RFC7240. The default timeout is 30 seconds and maximum timeout is 60 seconds |
{- "property1": {
- "border": {
- "color": "string",
- "lineStyle": "string",
- "width": 0
}, - "coordinates": {
- "lat": 0,
- "lng": 0
}, - "cutout": true,
- "fontIcon": {
- "color": "string",
- "fontFamily": "string",
- "text": "string"
}, - "halos": [
- {
- "color": "string",
- "radius": 0,
- "width": 0
}
], - "image": "string",
- "label": {
- "backgroundColor": "string",
- "bold": true,
- "center": true,
- "color": "string",
- "fontFamily": "string",
- "fontSize": 0,
- "text": "string"
}, - "shape": "string",
- "size": 0,
- "color": "string",
- "fade": true,
- "data": {
- "property1": { },
- "property2": { }
}, - "glyphs": [
- {
- "angle": 0,
- "blink": true,
- "border": {
- "color": "string"
}, - "color": "string",
- "fontIcon": {
- "color": "string",
- "fontFamily": "string",
- "text": "string"
}, - "image": "string",
- "label": {
- "bold": true,
- "color": "string",
- "fontFamily": "string",
- "text": "string"
}, - "position": "string",
- "radius": 0,
- "size": 0
}
]
}, - "property2": {
- "border": {
- "color": "string",
- "lineStyle": "string",
- "width": 0
}, - "coordinates": {
- "lat": 0,
- "lng": 0
}, - "cutout": true,
- "fontIcon": {
- "color": "string",
- "fontFamily": "string",
- "text": "string"
}, - "halos": [
- {
- "color": "string",
- "radius": 0,
- "width": 0
}
], - "image": "string",
- "label": {
- "backgroundColor": "string",
- "bold": true,
- "center": true,
- "color": "string",
- "fontFamily": "string",
- "fontSize": 0,
- "text": "string"
}, - "shape": "string",
- "size": 0,
- "color": "string",
- "fade": true,
- "data": {
- "property1": { },
- "property2": { }
}, - "glyphs": [
- {
- "angle": 0,
- "blink": true,
- "border": {
- "color": "string"
}, - "color": "string",
- "fontIcon": {
- "color": "string",
- "fontFamily": "string",
- "text": "string"
}, - "image": "string",
- "label": {
- "bold": true,
- "color": "string",
- "fontFamily": "string",
- "text": "string"
}, - "position": "string",
- "radius": 0,
- "size": 0
}
]
}
}Get a list, graph, or count of the principals this group can control.
| object_id required | string (object-id) The object id of the entity being operated on. |
| skip | integer >= 0 Default: 0 The number of entries to skip for pagination. Only available for |
| limit | integer >= 0 Default: 10 The number of entries to limit in the response. Only available for |
| type | string Default: "list" Enum: "list" "graph" "count" The type of return data requested. If no type is provided, query will default to |
| sort_by | string (sort-by) Sort by column. Can be used multiple times; prepend a hyphen for descending order. Columns available for sorting are dependent on the entity object kind. |
| Prefer | integer [ 0 .. 60 ] Default: 30 Prefer header, used to specify a custom timeout in seconds using the wait parameter as per RFC7240. The default timeout is 30 seconds and maximum timeout is 60 seconds |
{- "property1": {
- "border": {
- "color": "string",
- "lineStyle": "string",
- "width": 0
}, - "coordinates": {
- "lat": 0,
- "lng": 0
}, - "cutout": true,
- "fontIcon": {
- "color": "string",
- "fontFamily": "string",
- "text": "string"
}, - "halos": [
- {
- "color": "string",
- "radius": 0,
- "width": 0
}
], - "image": "string",
- "label": {
- "backgroundColor": "string",
- "bold": true,
- "center": true,
- "color": "string",
- "fontFamily": "string",
- "fontSize": 0,
- "text": "string"
}, - "shape": "string",
- "size": 0,
- "color": "string",
- "fade": true,
- "data": {
- "property1": { },
- "property2": { }
}, - "glyphs": [
- {
- "angle": 0,
- "blink": true,
- "border": {
- "color": "string"
}, - "color": "string",
- "fontIcon": {
- "color": "string",
- "fontFamily": "string",
- "text": "string"
}, - "image": "string",
- "label": {
- "bold": true,
- "color": "string",
- "fontFamily": "string",
- "text": "string"
}, - "position": "string",
- "radius": 0,
- "size": 0
}
]
}, - "property2": {
- "border": {
- "color": "string",
- "lineStyle": "string",
- "width": 0
}, - "coordinates": {
- "lat": 0,
- "lng": 0
}, - "cutout": true,
- "fontIcon": {
- "color": "string",
- "fontFamily": "string",
- "text": "string"
}, - "halos": [
- {
- "color": "string",
- "radius": 0,
- "width": 0
}
], - "image": "string",
- "label": {
- "backgroundColor": "string",
- "bold": true,
- "center": true,
- "color": "string",
- "fontFamily": "string",
- "fontSize": 0,
- "text": "string"
}, - "shape": "string",
- "size": 0,
- "color": "string",
- "fade": true,
- "data": {
- "property1": { },
- "property2": { }
}, - "glyphs": [
- {
- "angle": 0,
- "blink": true,
- "border": {
- "color": "string"
}, - "color": "string",
- "fontIcon": {
- "color": "string",
- "fontFamily": "string",
- "text": "string"
}, - "image": "string",
- "label": {
- "bold": true,
- "color": "string",
- "fontFamily": "string",
- "text": "string"
}, - "position": "string",
- "radius": 0,
- "size": 0
}
]
}
}Get a list, graph, or count of the principals that can control this group.
| object_id required | string (object-id) The object id of the entity being operated on. |
| skip | integer >= 0 Default: 0 The number of entries to skip for pagination. Only available for |
| limit | integer >= 0 Default: 10 The number of entries to limit in the response. Only available for |
| type | string Default: "list" Enum: "list" "graph" "count" The type of return data requested. If no type is provided, query will default to |
| sort_by | string (sort-by) Sort by column. Can be used multiple times; prepend a hyphen for descending order. Columns available for sorting are dependent on the entity object kind. |
| Prefer | integer [ 0 .. 60 ] Default: 30 Prefer header, used to specify a custom timeout in seconds using the wait parameter as per RFC7240. The default timeout is 30 seconds and maximum timeout is 60 seconds |
{- "property1": {
- "border": {
- "color": "string",
- "lineStyle": "string",
- "width": 0
}, - "coordinates": {
- "lat": 0,
- "lng": 0
}, - "cutout": true,
- "fontIcon": {
- "color": "string",
- "fontFamily": "string",
- "text": "string"
}, - "halos": [
- {
- "color": "string",
- "radius": 0,
- "width": 0
}
], - "image": "string",
- "label": {
- "backgroundColor": "string",
- "bold": true,
- "center": true,
- "color": "string",
- "fontFamily": "string",
- "fontSize": 0,
- "text": "string"
}, - "shape": "string",
- "size": 0,
- "color": "string",
- "fade": true,
- "data": {
- "property1": { },
- "property2": { }
}, - "glyphs": [
- {
- "angle": 0,
- "blink": true,
- "border": {
- "color": "string"
}, - "color": "string",
- "fontIcon": {
- "color": "string",
- "fontFamily": "string",
- "text": "string"
}, - "image": "string",
- "label": {
- "bold": true,
- "color": "string",
- "fontFamily": "string",
- "text": "string"
}, - "position": "string",
- "radius": 0,
- "size": 0
}
]
}, - "property2": {
- "border": {
- "color": "string",
- "lineStyle": "string",
- "width": 0
}, - "coordinates": {
- "lat": 0,
- "lng": 0
}, - "cutout": true,
- "fontIcon": {
- "color": "string",
- "fontFamily": "string",
- "text": "string"
}, - "halos": [
- {
- "color": "string",
- "radius": 0,
- "width": 0
}
], - "image": "string",
- "label": {
- "backgroundColor": "string",
- "bold": true,
- "center": true,
- "color": "string",
- "fontFamily": "string",
- "fontSize": 0,
- "text": "string"
}, - "shape": "string",
- "size": 0,
- "color": "string",
- "fade": true,
- "data": {
- "property1": { },
- "property2": { }
}, - "glyphs": [
- {
- "angle": 0,
- "blink": true,
- "border": {
- "color": "string"
}, - "color": "string",
- "fontIcon": {
- "color": "string",
- "fontFamily": "string",
- "text": "string"
}, - "image": "string",
- "label": {
- "bold": true,
- "color": "string",
- "fontFamily": "string",
- "text": "string"
}, - "position": "string",
- "radius": 0,
- "size": 0
}
]
}
}Get a list, graph, or count of the systems this group can execute DCOM on.
| object_id required | string (object-id) The object id of the entity being operated on. |
| skip | integer >= 0 Default: 0 The number of entries to skip for pagination. Only available for |
| limit | integer >= 0 Default: 10 The number of entries to limit in the response. Only available for |
| type | string Default: "list" Enum: "list" "graph" "count" The type of return data requested. If no type is provided, query will default to |
| sort_by | string (sort-by) Sort by column. Can be used multiple times; prepend a hyphen for descending order. Columns available for sorting are dependent on the entity object kind. |
| Prefer | integer [ 0 .. 60 ] Default: 30 Prefer header, used to specify a custom timeout in seconds using the wait parameter as per RFC7240. The default timeout is 30 seconds and maximum timeout is 60 seconds |
{- "property1": {
- "border": {
- "color": "string",
- "lineStyle": "string",
- "width": 0
}, - "coordinates": {
- "lat": 0,
- "lng": 0
}, - "cutout": true,
- "fontIcon": {
- "color": "string",
- "fontFamily": "string",
- "text": "string"
}, - "halos": [
- {
- "color": "string",
- "radius": 0,
- "width": 0
}
], - "image": "string",
- "label": {
- "backgroundColor": "string",
- "bold": true,
- "center": true,
- "color": "string",
- "fontFamily": "string",
- "fontSize": 0,
- "text": "string"
}, - "shape": "string",
- "size": 0,
- "color": "string",
- "fade": true,
- "data": {
- "property1": { },
- "property2": { }
}, - "glyphs": [
- {
- "angle": 0,
- "blink": true,
- "border": {
- "color": "string"
}, - "color": "string",
- "fontIcon": {
- "color": "string",
- "fontFamily": "string",
- "text": "string"
}, - "image": "string",
- "label": {
- "bold": true,
- "color": "string",
- "fontFamily": "string",
- "text": "string"
}, - "position": "string",
- "radius": 0,
- "size": 0
}
]
}, - "property2": {
- "border": {
- "color": "string",
- "lineStyle": "string",
- "width": 0
}, - "coordinates": {
- "lat": 0,
- "lng": 0
}, - "cutout": true,
- "fontIcon": {
- "color": "string",
- "fontFamily": "string",
- "text": "string"
}, - "halos": [
- {
- "color": "string",
- "radius": 0,
- "width": 0
}
], - "image": "string",
- "label": {
- "backgroundColor": "string",
- "bold": true,
- "center": true,
- "color": "string",
- "fontFamily": "string",
- "fontSize": 0,
- "text": "string"
}, - "shape": "string",
- "size": 0,
- "color": "string",
- "fade": true,
- "data": {
- "property1": { },
- "property2": { }
}, - "glyphs": [
- {
- "angle": 0,
- "blink": true,
- "border": {
- "color": "string"
}, - "color": "string",
- "fontIcon": {
- "color": "string",
- "fontFamily": "string",
- "text": "string"
}, - "image": "string",
- "label": {
- "bold": true,
- "color": "string",
- "fontFamily": "string",
- "text": "string"
}, - "position": "string",
- "radius": 0,
- "size": 0
}
]
}
}Get a list, graph, or count of the principals that are a member of this group.
| object_id required | string (object-id) The object id of the entity being operated on. |
| skip | integer >= 0 Default: 0 The number of entries to skip for pagination. Only available for |
| limit | integer >= 0 Default: 10 The number of entries to limit in the response. Only available for |
| type | string Default: "list" Enum: "list" "graph" "count" The type of return data requested. If no type is provided, query will default to |
| sort_by | string (sort-by) Sort by column. Can be used multiple times; prepend a hyphen for descending order. Columns available for sorting are dependent on the entity object kind. |
| Prefer | integer [ 0 .. 60 ] Default: 30 Prefer header, used to specify a custom timeout in seconds using the wait parameter as per RFC7240. The default timeout is 30 seconds and maximum timeout is 60 seconds |
{- "property1": {
- "border": {
- "color": "string",
- "lineStyle": "string",
- "width": 0
}, - "coordinates": {
- "lat": 0,
- "lng": 0
}, - "cutout": true,
- "fontIcon": {
- "color": "string",
- "fontFamily": "string",
- "text": "string"
}, - "halos": [
- {
- "color": "string",
- "radius": 0,
- "width": 0
}
], - "image": "string",
- "label": {
- "backgroundColor": "string",
- "bold": true,
- "center": true,
- "color": "string",
- "fontFamily": "string",
- "fontSize": 0,
- "text": "string"
}, - "shape": "string",
- "size": 0,
- "color": "string",
- "fade": true,
- "data": {
- "property1": { },
- "property2": { }
}, - "glyphs": [
- {
- "angle": 0,
- "blink": true,
- "border": {
- "color": "string"
}, - "color": "string",
- "fontIcon": {
- "color": "string",
- "fontFamily": "string",
- "text": "string"
}, - "image": "string",
- "label": {
- "bold": true,
- "color": "string",
- "fontFamily": "string",
- "text": "string"
}, - "position": "string",
- "radius": 0,
- "size": 0
}
]
}, - "property2": {
- "border": {
- "color": "string",
- "lineStyle": "string",
- "width": 0
}, - "coordinates": {
- "lat": 0,
- "lng": 0
}, - "cutout": true,
- "fontIcon": {
- "color": "string",
- "fontFamily": "string",
- "text": "string"
}, - "halos": [
- {
- "color": "string",
- "radius": 0,
- "width": 0
}
], - "image": "string",
- "label": {
- "backgroundColor": "string",
- "bold": true,
- "center": true,
- "color": "string",
- "fontFamily": "string",
- "fontSize": 0,
- "text": "string"
}, - "shape": "string",
- "size": 0,
- "color": "string",
- "fade": true,
- "data": {
- "property1": { },
- "property2": { }
}, - "glyphs": [
- {
- "angle": 0,
- "blink": true,
- "border": {
- "color": "string"
}, - "color": "string",
- "fontIcon": {
- "color": "string",
- "fontFamily": "string",
- "text": "string"
}, - "image": "string",
- "label": {
- "bold": true,
- "color": "string",
- "fontFamily": "string",
- "text": "string"
}, - "position": "string",
- "radius": 0,
- "size": 0
}
]
}
}Get a list, graph, or count of the groups this group is a member of.
| object_id required | string (object-id) The object id of the entity being operated on. |
| skip | integer >= 0 Default: 0 The number of entries to skip for pagination. Only available for |
| limit | integer >= 0 Default: 10 The number of entries to limit in the response. Only available for |
| type | string Default: "list" Enum: "list" "graph" "count" The type of return data requested. If no type is provided, query will default to |
| sort_by | string (sort-by) Sort by column. Can be used multiple times; prepend a hyphen for descending order. Columns available for sorting are dependent on the entity object kind. |
| Prefer | integer [ 0 .. 60 ] Default: 30 Prefer header, used to specify a custom timeout in seconds using the wait parameter as per RFC7240. The default timeout is 30 seconds and maximum timeout is 60 seconds |
{- "property1": {
- "border": {
- "color": "string",
- "lineStyle": "string",
- "width": 0
}, - "coordinates": {
- "lat": 0,
- "lng": 0
}, - "cutout": true,
- "fontIcon": {
- "color": "string",
- "fontFamily": "string",
- "text": "string"
}, - "halos": [
- {
- "color": "string",
- "radius": 0,
- "width": 0
}
], - "image": "string",
- "label": {
- "backgroundColor": "string",
- "bold": true,
- "center": true,
- "color": "string",
- "fontFamily": "string",
- "fontSize": 0,
- "text": "string"
}, - "shape": "string",
- "size": 0,
- "color": "string",
- "fade": true,
- "data": {
- "property1": { },
- "property2": { }
}, - "glyphs": [
- {
- "angle": 0,
- "blink": true,
- "border": {
- "color": "string"
}, - "color": "string",
- "fontIcon": {
- "color": "string",
- "fontFamily": "string",
- "text": "string"
}, - "image": "string",
- "label": {
- "bold": true,
- "color": "string",
- "fontFamily": "string",
- "text": "string"
}, - "position": "string",
- "radius": 0,
- "size": 0
}
]
}, - "property2": {
- "border": {
- "color": "string",
- "lineStyle": "string",
- "width": 0
}, - "coordinates": {
- "lat": 0,
- "lng": 0
}, - "cutout": true,
- "fontIcon": {
- "color": "string",
- "fontFamily": "string",
- "text": "string"
}, - "halos": [
- {
- "color": "string",
- "radius": 0,
- "width": 0
}
], - "image": "string",
- "label": {
- "backgroundColor": "string",
- "bold": true,
- "center": true,
- "color": "string",
- "fontFamily": "string",
- "fontSize": 0,
- "text": "string"
}, - "shape": "string",
- "size": 0,
- "color": "string",
- "fade": true,
- "data": {
- "property1": { },
- "property2": { }
}, - "glyphs": [
- {
- "angle": 0,
- "blink": true,
- "border": {
- "color": "string"
}, - "color": "string",
- "fontIcon": {
- "color": "string",
- "fontFamily": "string",
- "text": "string"
}, - "image": "string",
- "label": {
- "bold": true,
- "color": "string",
- "fontFamily": "string",
- "text": "string"
}, - "position": "string",
- "radius": 0,
- "size": 0
}
]
}
}Get a list, graph, or count of the systems this group can execute PowerShell remote on.
| object_id required | string (object-id) The object id of the entity being operated on. |
| skip | integer >= 0 Default: 0 The number of entries to skip for pagination. Only available for |
| limit | integer >= 0 Default: 10 The number of entries to limit in the response. Only available for |
| type | string Default: "list" Enum: "list" "graph" "count" The type of return data requested. If no type is provided, query will default to |
| sort_by | string (sort-by) Sort by column. Can be used multiple times; prepend a hyphen for descending order. Columns available for sorting are dependent on the entity object kind. |
| Prefer | integer [ 0 .. 60 ] Default: 30 Prefer header, used to specify a custom timeout in seconds using the wait parameter as per RFC7240. The default timeout is 30 seconds and maximum timeout is 60 seconds |
{- "property1": {
- "border": {
- "color": "string",
- "lineStyle": "string",
- "width": 0
}, - "coordinates": {
- "lat": 0,
- "lng": 0
}, - "cutout": true,
- "fontIcon": {
- "color": "string",
- "fontFamily": "string",
- "text": "string"
}, - "halos": [
- {
- "color": "string",
- "radius": 0,
- "width": 0
}
], - "image": "string",
- "label": {
- "backgroundColor": "string",
- "bold": true,
- "center": true,
- "color": "string",
- "fontFamily": "string",
- "fontSize": 0,
- "text": "string"
}, - "shape": "string",
- "size": 0,
- "color": "string",
- "fade": true,
- "data": {
- "property1": { },
- "property2": { }
}, - "glyphs": [
- {
- "angle": 0,
- "blink": true,
- "border": {
- "color": "string"
}, - "color": "string",
- "fontIcon": {
- "color": "string",
- "fontFamily": "string",
- "text": "string"
}, - "image": "string",
- "label": {
- "bold": true,
- "color": "string",
- "fontFamily": "string",
- "text": "string"
}, - "position": "string",
- "radius": 0,
- "size": 0
}
]
}, - "property2": {
- "border": {
- "color": "string",
- "lineStyle": "string",
- "width": 0
}, - "coordinates": {
- "lat": 0,
- "lng": 0
}, - "cutout": true,
- "fontIcon": {
- "color": "string",
- "fontFamily": "string",
- "text": "string"
}, - "halos": [
- {
- "color": "string",
- "radius": 0,
- "width": 0
}
], - "image": "string",
- "label": {
- "backgroundColor": "string",
- "bold": true,
- "center": true,
- "color": "string",
- "fontFamily": "string",
- "fontSize": 0,
- "text": "string"
}, - "shape": "string",
- "size": 0,
- "color": "string",
- "fade": true,
- "data": {
- "property1": { },
- "property2": { }
}, - "glyphs": [
- {
- "angle": 0,
- "blink": true,
- "border": {
- "color": "string"
}, - "color": "string",
- "fontIcon": {
- "color": "string",
- "fontFamily": "string",
- "text": "string"
}, - "image": "string",
- "label": {
- "bold": true,
- "color": "string",
- "fontFamily": "string",
- "text": "string"
}, - "position": "string",
- "radius": 0,
- "size": 0
}
]
}
}Get a list, graph, or count of the systems this group can RDP to.
| object_id required | string (object-id) The object id of the entity being operated on. |
| skip | integer >= 0 Default: 0 The number of entries to skip for pagination. Only available for |
| limit | integer >= 0 Default: 10 The number of entries to limit in the response. Only available for |
| type | string Default: "list" Enum: "list" "graph" "count" The type of return data requested. If no type is provided, query will default to |
| sort_by | string (sort-by) Sort by column. Can be used multiple times; prepend a hyphen for descending order. Columns available for sorting are dependent on the entity object kind. |
| Prefer | integer [ 0 .. 60 ] Default: 30 Prefer header, used to specify a custom timeout in seconds using the wait parameter as per RFC7240. The default timeout is 30 seconds and maximum timeout is 60 seconds |
{- "property1": {
- "border": {
- "color": "string",
- "lineStyle": "string",
- "width": 0
}, - "coordinates": {
- "lat": 0,
- "lng": 0
}, - "cutout": true,
- "fontIcon": {
- "color": "string",
- "fontFamily": "string",
- "text": "string"
}, - "halos": [
- {
- "color": "string",
- "radius": 0,
- "width": 0
}
], - "image": "string",
- "label": {
- "backgroundColor": "string",
- "bold": true,
- "center": true,
- "color": "string",
- "fontFamily": "string",
- "fontSize": 0,
- "text": "string"
}, - "shape": "string",
- "size": 0,
- "color": "string",
- "fade": true,
- "data": {
- "property1": { },
- "property2": { }
}, - "glyphs": [
- {
- "angle": 0,
- "blink": true,
- "border": {
- "color": "string"
}, - "color": "string",
- "fontIcon": {
- "color": "string",
- "fontFamily": "string",
- "text": "string"
}, - "image": "string",
- "label": {
- "bold": true,
- "color": "string",
- "fontFamily": "string",
- "text": "string"
}, - "position": "string",
- "radius": 0,
- "size": 0
}
]
}, - "property2": {
- "border": {
- "color": "string",
- "lineStyle": "string",
- "width": 0
}, - "coordinates": {
- "lat": 0,
- "lng": 0
}, - "cutout": true,
- "fontIcon": {
- "color": "string",
- "fontFamily": "string",
- "text": "string"
}, - "halos": [
- {
- "color": "string",
- "radius": 0,
- "width": 0
}
], - "image": "string",
- "label": {
- "backgroundColor": "string",
- "bold": true,
- "center": true,
- "color": "string",
- "fontFamily": "string",
- "fontSize": 0,
- "text": "string"
}, - "shape": "string",
- "size": 0,
- "color": "string",
- "fade": true,
- "data": {
- "property1": { },
- "property2": { }
}, - "glyphs": [
- {
- "angle": 0,
- "blink": true,
- "border": {
- "color": "string"
}, - "color": "string",
- "fontIcon": {
- "color": "string",
- "fontFamily": "string",
- "text": "string"
}, - "image": "string",
- "label": {
- "bold": true,
- "color": "string",
- "fontFamily": "string",
- "text": "string"
}, - "position": "string",
- "radius": 0,
- "size": 0
}
]
}
}Get a list, graph, or count of the active sessions for users that belong to this group.
| object_id required | string (object-id) The object id of the entity being operated on. |
| skip | integer >= 0 Default: 0 The number of entries to skip for pagination. Only available for |
| limit | integer >= 0 Default: 10 The number of entries to limit in the response. Only available for |
| type | string Default: "list" Enum: "list" "graph" "count" The type of return data requested. If no type is provided, query will default to |
| sort_by | string (sort-by) Sort by column. Can be used multiple times; prepend a hyphen for descending order. Columns available for sorting are dependent on the entity object kind. |
| Prefer | integer [ 0 .. 60 ] Default: 30 Prefer header, used to specify a custom timeout in seconds using the wait parameter as per RFC7240. The default timeout is 30 seconds and maximum timeout is 60 seconds |
{- "property1": {
- "border": {
- "color": "string",
- "lineStyle": "string",
- "width": 0
}, - "coordinates": {
- "lat": 0,
- "lng": 0
}, - "cutout": true,
- "fontIcon": {
- "color": "string",
- "fontFamily": "string",
- "text": "string"
}, - "halos": [
- {
- "color": "string",
- "radius": 0,
- "width": 0
}
], - "image": "string",
- "label": {
- "backgroundColor": "string",
- "bold": true,
- "center": true,
- "color": "string",
- "fontFamily": "string",
- "fontSize": 0,
- "text": "string"
}, - "shape": "string",
- "size": 0,
- "color": "string",
- "fade": true,
- "data": {
- "property1": { },
- "property2": { }
}, - "glyphs": [
- {
- "angle": 0,
- "blink": true,
- "border": {
- "color": "string"
}, - "color": "string",
- "fontIcon": {
- "color": "string",
- "fontFamily": "string",
- "text": "string"
}, - "image": "string",
- "label": {
- "bold": true,
- "color": "string",
- "fontFamily": "string",
- "text": "string"
}, - "position": "string",
- "radius": 0,
- "size": 0
}
]
}, - "property2": {
- "border": {
- "color": "string",
- "lineStyle": "string",
- "width": 0
}, - "coordinates": {
- "lat": 0,
- "lng": 0
}, - "cutout": true,
- "fontIcon": {
- "color": "string",
- "fontFamily": "string",
- "text": "string"
}, - "halos": [
- {
- "color": "string",
- "radius": 0,
- "width": 0
}
], - "image": "string",
- "label": {
- "backgroundColor": "string",
- "bold": true,
- "center": true,
- "color": "string",
- "fontFamily": "string",
- "fontSize": 0,
- "text": "string"
}, - "shape": "string",
- "size": 0,
- "color": "string",
- "fade": true,
- "data": {
- "property1": { },
- "property2": { }
}, - "glyphs": [
- {
- "angle": 0,
- "blink": true,
- "border": {
- "color": "string"
}, - "color": "string",
- "fontIcon": {
- "color": "string",
- "fontFamily": "string",
- "text": "string"
}, - "image": "string",
- "label": {
- "bold": true,
- "color": "string",
- "fontFamily": "string",
- "text": "string"
}, - "position": "string",
- "radius": 0,
- "size": 0
}
]
}
}Get the percentage of local admins and sessions collected
| Prefer | integer [ 0 .. 60 ] Default: 30 Prefer header, used to specify a custom timeout in seconds using the wait parameter as per RFC7240. The default timeout is 30 seconds and maximum timeout is 60 seconds |
{- "data": {
- "property1": 0.1,
- "property2": 0.1
}
}Time series list of data quality stats for a given AD domain
| domain_id required | string Domain ID |
| sort_by | string (sort-by) Sortable columns are created_at, updated_at. |
| start | string <date-time> Beginning datetime of range (inclusive) in RFC-3339 format; Defaults to current datetime minus 30 days |
| end | string <date-time> Ending datetime of range (exclusive) in RFC-3339 format; Defaults to current datetime |
| skip | integer (skip) >= 0 This query parameter is used for determining the number of objects to skip in pagination. |
| limit | integer (limit) >= 0 This query parameter is used for setting an upper limit of objects returned in paginated responses. |
| Prefer | integer [ 0 .. 60 ] Default: 30 Prefer header, used to specify a custom timeout in seconds using the wait parameter as per RFC7240. The default timeout is 30 seconds and maximum timeout is 60 seconds |
{- "count": 0,
- "skip": 0,
- "limit": 0,
- "start": "2019-08-24T14:15:22Z",
- "end": "2019-08-24T14:15:22Z",
- "data": [
- {
- "domain_sid": "string",
- "users": 0,
- "groups": 0,
- "computers": 0,
- "ous": 0,
- "containers": 0,
- "gpos": 0,
- "aiacas": 0,
- "rootcas": 0,
- "enterprisecas": 0,
- "ntauthstores": 0,
- "certtemplates": 0,
- "acls": 0,
- "sessions": 0,
- "relationships": 0,
- "session_completeness": 0.1,
- "local_group_completeness": 0.1,
- "run_id": "dded282c-8ebd-44cf-8ba5-9a234973d1ec",
- "id": 0,
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z",
- "deleted_at": {
- "time": "2019-08-24T14:15:22Z",
- "valid": true
}
}
]
}Time series list of data quality stats for a given Azure tenant
| tenant_id required | string Tenant ID |
| sort_by | string (sort-by) Sortable columns are created_at, updated_at. |
| start | string <date-time> Beginning datetime of range (inclusive) in RFC-3339 format; Defaults to current datetime minus 30 days |
| end | string <date-time> Ending datetime of range (exclusive) in RFC-3339 format; Defaults to current datetime |
| skip | integer (skip) >= 0 This query parameter is used for determining the number of objects to skip in pagination. |
| limit | integer (limit) >= 0 This query parameter is used for setting an upper limit of objects returned in paginated responses. |
| Prefer | integer [ 0 .. 60 ] Default: 30 Prefer header, used to specify a custom timeout in seconds using the wait parameter as per RFC7240. The default timeout is 30 seconds and maximum timeout is 60 seconds |
{- "count": 0,
- "skip": 0,
- "limit": 0,
- "start": "2019-08-24T14:15:22Z",
- "end": "2019-08-24T14:15:22Z",
- "data": [
- {
- "tenantid": "d97794b1-67e3-498f-9ef0-da48aa6748c6",
- "users": 0,
- "groups": 0,
- "apps": 0,
- "service_principals": 0,
- "devices": 0,
- "management_groups": 0,
- "subscriptions": 0,
- "resource_groups": 0,
- "vms": 0,
- "key_vaults": 0,
- "relationships": 0,
- "run_id": "dded282c-8ebd-44cf-8ba5-9a234973d1ec",
- "id": 0,
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z",
- "deleted_at": {
- "time": "2019-08-24T14:15:22Z",
- "valid": true
}
}
]
}Time series list of aggregate data quality stats for a given platform
| platform_id required | string Enum: "ad" "azure" Platform ID |
| sort_by | string (sort-by) Sortable columns are created_at, updated_at. |
| start | string <date-time> Beginning datetime of range (inclusive) in RFC-3339 format; Defaults to current datetime minus 30 days |
| end | string <date-time> Ending datetime of range (exclusive) in RFC-3339 format; Defaults to current datetime |
| skip | integer (skip) >= 0 This query parameter is used for determining the number of objects to skip in pagination. |
| limit | integer (limit) >= 0 This query parameter is used for setting an upper limit of objects returned in paginated responses. |
| Prefer | integer [ 0 .. 60 ] Default: 30 Prefer header, used to specify a custom timeout in seconds using the wait parameter as per RFC7240. The default timeout is 30 seconds and maximum timeout is 60 seconds |
{- "count": 0,
- "skip": 0,
- "limit": 0,
- "start": "2019-08-24T14:15:22Z",
- "end": "2019-08-24T14:15:22Z",
- "data": [
- {
- "domains": 0,
- "users": 0,
- "groups": 0,
- "computers": 0,
- "ous": 0,
- "containers": 0,
- "gpos": 0,
- "aiacas": 0,
- "rootcas": 0,
- "enterprisecas": 0,
- "ntauthstores": 0,
- "certtemplates": 0,
- "acls": 0,
- "sessions": 0,
- "relationships": 0,
- "session_completeness": 0.1,
- "local_group_completeness": 0.1,
- "run_id": "dded282c-8ebd-44cf-8ba5-9a234973d1ec",
- "id": 0,
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z",
- "deleted_at": {
- "time": "2019-08-24T14:15:22Z",
- "valid": true
}
}
]
}Gets the current status of the datapipe
| Prefer | integer [ 0 .. 60 ] Default: 30 Prefer header, used to specify a custom timeout in seconds using the wait parameter as per RFC7240. The default timeout is 30 seconds and maximum timeout is 60 seconds |
{- "data": {
- "status": "idle",
- "updated_at": "2019-08-24T14:15:22Z",
- "last_complete_analysis_at": "2019-08-24T14:15:22Z"
}
}Flags the API to begin analyzing ingest data.
| Prefer | integer [ 0 .. 60 ] Default: 30 Prefer header, used to specify a custom timeout in seconds using the wait parameter as per RFC7240. The default timeout is 30 seconds and maximum timeout is 60 seconds |
[this request has no response data]
Get all saved queries for the current user
| skip | integer (skip) >= 0 This query parameter is used for determining the number of objects to skip in pagination. |
| limit | integer (limit) >= 0 This query parameter is used for setting an upper limit of objects returned in paginated responses. |
| sort_by | string (sort-by) Sortable columns are user_id, name, query, id, created_at, updated_at, deleted_at. |
| name | string (filter.string) Filter results by column string value. Valid filter predicates are |
| query | string (filter.string) Filter results by column string value. Valid filter predicates are |
| user_id | string (filter.string) Filter results by column string value. Valid filter predicates are |
| Prefer | integer [ 0 .. 60 ] Default: 30 Prefer header, used to specify a custom timeout in seconds using the wait parameter as per RFC7240. The default timeout is 30 seconds and maximum timeout is 60 seconds |
{- "data": [
- {
- "user_id": "a169451c-8525-4352-b8ca-070dd449a1a5",
- "name": "string",
- "query": "string",
- "id": 0,
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z",
- "deleted_at": {
- "time": "2019-08-24T14:15:22Z",
- "valid": true
}
}
], - "count": 0,
- "skip": 0,
- "limit": 0
}Create a new saved query
| Prefer | integer [ 0 .. 60 ] Default: 30 Prefer header, used to specify a custom timeout in seconds using the wait parameter as per RFC7240. The default timeout is 30 seconds and maximum timeout is 60 seconds |
The request body for creating a saved query
| name | string |
| query | string |
{- "name": "string",
- "query": "string"
}{- "data": {
- "user_id": "a169451c-8525-4352-b8ca-070dd449a1a5",
- "name": "string",
- "query": "string",
- "id": 0,
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z",
- "deleted_at": {
- "time": "2019-08-24T14:15:22Z",
- "valid": true
}
}
}Delete an existing saved query by ID
| saved_query_id required | integer <int32> ID of the saved query |
| Prefer | integer [ 0 .. 60 ] Default: 30 Prefer header, used to specify a custom timeout in seconds using the wait parameter as per RFC7240. The default timeout is 30 seconds and maximum timeout is 60 seconds |
[this request has no response data]
Runs a manual cypher query directly against the database
| Prefer | integer [ 0 .. 60 ] Default: 30 Prefer header, used to specify a custom timeout in seconds using the wait parameter as per RFC7240. The default timeout is 30 seconds and maximum timeout is 60 seconds |
| query | string |
| include_properties | boolean |
{- "query": "string",
- "include_properties": true
}{- "data": {
- "nodes": {
- "property1": {
- "label": "string",
- "kind": "string",
- "objectId": "string",
- "isTierZero": "string",
- "lastSeen": "2019-08-24T14:15:22Z",
- "properties": {
- "property1": { },
- "property2": { }
}
}, - "property2": {
- "label": "string",
- "kind": "string",
- "objectId": "string",
- "isTierZero": "string",
- "lastSeen": "2019-08-24T14:15:22Z",
- "properties": {
- "property1": { },
- "property2": { }
}
}
}, - "edges": [
- {
- "source": "string",
- "target": "string",
- "label": "string",
- "kind": "string",
- "lastSeen": "2019-08-24T14:15:22Z",
- "properties": {
- "property1": { },
- "property2": { }
}
}
]
}
}Accept BloodHound Enterprise EULA for logged in user (EULA applies to BHE customers only).
| Prefer | integer [ 0 .. 60 ] Default: 30 Prefer header, used to specify a custom timeout in seconds using the wait parameter as per RFC7240. The default timeout is 30 seconds and maximum timeout is 60 seconds |
[this request has no response data]
Get latest tier zero combo node
| domain_id required | string Domain ID |
| Prefer | integer [ 0 .. 60 ] Default: 30 Prefer header, used to specify a custom timeout in seconds using the wait parameter as per RFC7240. The default timeout is 30 seconds and maximum timeout is 60 seconds |
{- "data": {
- "property1": {
- "border": {
- "color": "string",
- "lineStyle": "string",
- "width": 0
}, - "coordinates": {
- "lat": 0,
- "lng": 0
}, - "cutout": true,
- "fontIcon": {
- "color": "string",
- "fontFamily": "string",
- "text": "string"
}, - "halos": [
- {
- "color": "string",
- "radius": 0,
- "width": 0
}
], - "image": "string",
- "label": {
- "backgroundColor": "string",
- "bold": true,
- "center": true,
- "color": "string",
- "fontFamily": "string",
- "fontSize": 0,
- "text": "string"
}, - "shape": "string",
- "size": 0,
- "color": "string",
- "fade": true,
- "data": {
- "property1": { },
- "property2": { }
}, - "glyphs": [
- {
- "angle": 0,
- "blink": true,
- "border": {
- "color": "string"
}, - "color": "string",
- "fontIcon": {
- "color": "string",
- "fontFamily": "string",
- "text": "string"
}, - "image": "string",
- "label": {
- "bold": true,
- "color": "string",
- "fontFamily": "string",
- "text": "string"
}, - "position": "string",
- "radius": 0,
- "size": 0
}
]
}, - "property2": {
- "border": {
- "color": "string",
- "lineStyle": "string",
- "width": 0
}, - "coordinates": {
- "lat": 0,
- "lng": 0
}, - "cutout": true,
- "fontIcon": {
- "color": "string",
- "fontFamily": "string",
- "text": "string"
}, - "halos": [
- {
- "color": "string",
- "radius": 0,
- "width": 0
}
], - "image": "string",
- "label": {
- "backgroundColor": "string",
- "bold": true,
- "center": true,
- "color": "string",
- "fontFamily": "string",
- "fontSize": 0,
- "text": "string"
}, - "shape": "string",
- "size": 0,
- "color": "string",
- "fade": true,
- "data": {
- "property1": { },
- "property2": { }
}, - "glyphs": [
- {
- "angle": 0,
- "blink": true,
- "border": {
- "color": "string"
}, - "color": "string",
- "fontIcon": {
- "color": "string",
- "fontFamily": "string",
- "text": "string"
}, - "image": "string",
- "label": {
- "bold": true,
- "color": "string",
- "fontFamily": "string",
- "text": "string"
}, - "position": "string",
- "radius": 0,
- "size": 0
}
]
}
}
}Gets meta nodes and connecting edges
| domain_id required | string Domain ID |
| node_id | integer <int64> Node ID |
| Prefer | integer [ 0 .. 60 ] Default: 30 Prefer header, used to specify a custom timeout in seconds using the wait parameter as per RFC7240. The default timeout is 30 seconds and maximum timeout is 60 seconds |
{- "data": {
- "property1": {
- "border": {
- "color": "string",
- "lineStyle": "string",
- "width": 0
}, - "coordinates": {
- "lat": 0,
- "lng": 0
}, - "cutout": true,
- "fontIcon": {
- "color": "string",
- "fontFamily": "string",
- "text": "string"
}, - "halos": [
- {
- "color": "string",
- "radius": 0,
- "width": 0
}
], - "image": "string",
- "label": {
- "backgroundColor": "string",
- "bold": true,
- "center": true,
- "color": "string",
- "fontFamily": "string",
- "fontSize": 0,
- "text": "string"
}, - "shape": "string",
- "size": 0,
- "color": "string",
- "fade": true,
- "data": {
- "property1": { },
- "property2": { }
}, - "glyphs": [
- {
- "angle": 0,
- "blink": true,
- "border": {
- "color": "string"
}, - "color": "string",
- "fontIcon": {
- "color": "string",
- "fontFamily": "string",
- "text": "string"
}, - "image": "string",
- "label": {
- "bold": true,
- "color": "string",
- "fontFamily": "string",
- "text": "string"
}, - "position": "string",
- "radius": 0,
- "size": 0
}
]
}, - "property2": {
- "border": {
- "color": "string",
- "lineStyle": "string",
- "width": 0
}, - "coordinates": {
- "lat": 0,
- "lng": 0
}, - "cutout": true,
- "fontIcon": {
- "color": "string",
- "fontFamily": "string",
- "text": "string"
}, - "halos": [
- {
- "color": "string",
- "radius": 0,
- "width": 0
}
], - "image": "string",
- "label": {
- "backgroundColor": "string",
- "bold": true,
- "center": true,
- "color": "string",
- "fontFamily": "string",
- "fontSize": 0,
- "text": "string"
}, - "shape": "string",
- "size": 0,
- "color": "string",
- "fade": true,
- "data": {
- "property1": { },
- "property2": { }
}, - "glyphs": [
- {
- "angle": 0,
- "blink": true,
- "border": {
- "color": "string"
}, - "color": "string",
- "fontIcon": {
- "color": "string",
- "fontFamily": "string",
- "text": "string"
}, - "image": "string",
- "label": {
- "bold": true,
- "color": "string",
- "fontFamily": "string",
- "text": "string"
}, - "position": "string",
- "radius": 0,
- "size": 0
}
]
}
}
}Gets the combo tree for an asset group
| asset_group_id required | integer <int32> Asset Group Object ID |
| domainsid | string Filter by Domain security identifier. |
| Prefer | integer [ 0 .. 60 ] Default: 30 Prefer header, used to specify a custom timeout in seconds using the wait parameter as per RFC7240. The default timeout is 30 seconds and maximum timeout is 60 seconds |
{- "data": {
- "property1": {
- "border": {
- "color": "string",
- "lineStyle": "string",
- "width": 0
}, - "coordinates": {
- "lat": 0,
- "lng": 0
}, - "cutout": true,
- "fontIcon": {
- "color": "string",
- "fontFamily": "string",
- "text": "string"
}, - "halos": [
- {
- "color": "string",
- "radius": 0,
- "width": 0
}
], - "image": "string",
- "label": {
- "backgroundColor": "string",
- "bold": true,
- "center": true,
- "color": "string",
- "fontFamily": "string",
- "fontSize": 0,
- "text": "string"
}, - "shape": "string",
- "size": 0,
- "color": "string",
- "fade": true,
- "data": {
- "property1": { },
- "property2": { }
}, - "glyphs": [
- {
- "angle": 0,
- "blink": true,
- "border": {
- "color": "string"
}, - "color": "string",
- "fontIcon": {
- "color": "string",
- "fontFamily": "string",
- "text": "string"
}, - "image": "string",
- "label": {
- "bold": true,
- "color": "string",
- "fontFamily": "string",
- "text": "string"
}, - "position": "string",
- "radius": 0,
- "size": 0
}
]
}, - "property2": {
- "border": {
- "color": "string",
- "lineStyle": "string",
- "width": 0
}, - "coordinates": {
- "lat": 0,
- "lng": 0
}, - "cutout": true,
- "fontIcon": {
- "color": "string",
- "fontFamily": "string",
- "text": "string"
}, - "halos": [
- {
- "color": "string",
- "radius": 0,
- "width": 0
}
], - "image": "string",
- "label": {
- "backgroundColor": "string",
- "bold": true,
- "center": true,
- "color": "string",
- "fontFamily": "string",
- "fontSize": 0,
- "text": "string"
}, - "shape": "string",
- "size": 0,
- "color": "string",
- "fade": true,
- "data": {
- "property1": { },
- "property2": { }
}, - "glyphs": [
- {
- "angle": 0,
- "blink": true,
- "border": {
- "color": "string"
}, - "color": "string",
- "fontIcon": {
- "color": "string",
- "fontFamily": "string",
- "text": "string"
}, - "image": "string",
- "label": {
- "bold": true,
- "color": "string",
- "fontFamily": "string",
- "text": "string"
}, - "position": "string",
- "radius": 0,
- "size": 0
}
]
}
}
}Ingests data from collector clients
| Prefer | integer [ 0 .. 60 ] Default: 30 Prefer header, used to specify a custom timeout in seconds using the wait parameter as per RFC7240. The default timeout is 30 seconds and maximum timeout is 60 seconds |
[this request has no response data]
Lists available clients for processing collection events.
| created_at | string <date-time> (filter.time) Filter results by |
| updated_at | string <date-time> (filter.time) Filter results by |
| deleted_at | string <date-time> (filter.time) Filter results by |
| hydrate_domains | boolean Default: true When a value of |
| hydrate_ous | boolean Default: true When a value of |
| skip | integer (skip) >= 0 This query parameter is used for determining the number of objects to skip in pagination. |
| limit | integer (limit) >= 0 This query parameter is used for setting an upper limit of objects returned in paginated responses. |
| sort_by | string (sort-by) Sortable columns are |
| name | string (filter.string) Filter results by column string value. Valid filter predicates are |
| ip_address | string (filter.string) Filter results by column string value. Valid filter predicates are |
| hostname | string (filter.string) Filter results by column string value. Valid filter predicates are |
| configured_user | string (filter.string) Filter results by column string value. Valid filter predicates are |
| version | string (filter.string) Filter results by column string value. Valid filter predicates are |
| user_sid | string (filter.string) Filter results by column string value. Valid filter predicates are |
| last_checkin | string (filter.string) Filter results by column string value. Valid filter predicates are |
| current_job_id | integer (filter.integer) Filter results by column integer value. Valid filter predicates are |
| completed_job_count | integer (filter.integer) Filter results by column integer value. Valid filter predicates are |
| domain_controller | string (filter.string) Filter results by column string value. Valid filter predicates are |
| id | string <uuid> (filter.uuid) Filter results by column string-formatted uuid value. Valid filter predicates are |
| Prefer | integer [ 0 .. 60 ] Default: 30 Prefer header, used to specify a custom timeout in seconds using the wait parameter as per RFC7240. The default timeout is 30 seconds and maximum timeout is 60 seconds |
{- "count": 0,
- "skip": 0,
- "limit": 0,
- "data": [
- {
- "name": "string",
- "ip_address": "192.168.0.1",
- "hostname": "string",
- "configured_user": "string",
- "last_checkin": "2019-08-24T14:15:22Z",
- "events": [
- {
- "client_id": "5b3fa7ba-57d3-4017-a65b-d57dcd2db643",
- "rrule": "string",
- "session_collection": true,
- "local_group_collection": true,
- "ad_structure_collection": true,
- "cert_services_collection": true,
- "ca_registry_collection": true,
- "dc_registry_collection": true,
- "all_trusted_domains": true,
- "ous": [
- {
- "distinguishedname": "string",
- "type": "string",
- "objectid": "string",
- "name": "string",
- "exists": true
}
], - "domains": [
- {
- "type": "string",
- "objectid": "string",
- "name": "string",
- "exists": true
}
], - "id": 0
}
], - "token": {
- "user_id": {
- "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
- "valid": true
}, - "name": {
- "string": "string",
- "valid": true
}, - "key": "string",
- "hmac_method": "string",
- "last_access": "2019-08-24T14:15:22Z",
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z",
- "deleted_at": {
- "time": "2019-08-24T14:15:22Z",
- "valid": true
}
}, - "current_job_id": {
- "int64": 0,
- "valid": true
}, - "current_task_id": {
- "int64": 0,
- "valid": true
}, - "current_job": {
- "client_id": "5b3fa7ba-57d3-4017-a65b-d57dcd2db643",
- "client_name": "string",
- "event_id": {
- "int32": 0,
- "valid": true
}, - "execution_time": "2019-08-24T14:15:22Z",
- "start_time": "2019-08-24T14:15:22Z",
- "end_time": "2019-08-24T14:15:22Z",
- "status": -1,
- "status_message": "string",
- "session_collection": true,
- "local_group_collection": true,
- "ad_structure_collection": true,
- "cert_services_collection": true,
- "ca_registry_collection": true,
- "dc_registry_collection": true,
- "all_trusted_domains": true,
- "domain_controller": "string",
- "ous": [
- {
- "distinguishedname": "string",
- "type": "string",
- "objectid": "string",
- "name": "string",
- "exists": true
}
], - "domains": [
- {
- "type": "string",
- "objectid": "string",
- "name": "string",
- "exists": true
}
], - "domain_results": [
- {
- "job_id": 0,
- "domain_name": "string",
- "success": true,
- "message": "string",
- "user_count": 0,
- "group_count": 0,
- "computer_count": 0,
- "gpo_count": 0,
- "ou_count": 0,
- "container_count": 0,
- "aiaca_count": 0,
- "rootca_count": 0,
- "enterpriseca_count": 0,
- "ntauthstore_count": 0,
- "certtemplate_count": 0,
- "deleted_count": 0,
- "id": 0,
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z",
- "deleted_at": {
- "time": "2019-08-24T14:15:22Z",
- "valid": true
}
}
], - "id": 0
}, - "current_task": {
- "client_id": "5b3fa7ba-57d3-4017-a65b-d57dcd2db643",
- "client_name": "string",
- "event_id": {
- "int32": 0,
- "valid": true
}, - "execution_time": "2019-08-24T14:15:22Z",
- "start_time": "2019-08-24T14:15:22Z",
- "end_time": "2019-08-24T14:15:22Z",
- "status": -1,
- "status_message": "string",
- "session_collection": true,
- "local_group_collection": true,
- "ad_structure_collection": true,
- "cert_services_collection": true,
- "ca_registry_collection": true,
- "dc_registry_collection": true,
- "all_trusted_domains": true,
- "domain_controller": "string",
- "ous": [
- {
- "distinguishedname": "string",
- "type": "string",
- "objectid": "string",
- "name": "string",
- "exists": true
}
], - "domains": [
- {
- "type": "string",
- "objectid": "string",
- "name": "string",
- "exists": true
}
], - "domain_results": [
- {
- "job_id": 0,
- "domain_name": "string",
- "success": true,
- "message": "string",
- "user_count": 0,
- "group_count": 0,
- "computer_count": 0,
- "gpo_count": 0,
- "ou_count": 0,
- "container_count": 0,
- "aiaca_count": 0,
- "rootca_count": 0,
- "enterpriseca_count": 0,
- "ntauthstore_count": 0,
- "certtemplate_count": 0,
- "deleted_count": 0,
- "id": 0,
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z",
- "deleted_at": {
- "time": "2019-08-24T14:15:22Z",
- "valid": true
}
}
], - "id": 0
}, - "completed_job_count": 0,
- "completed_task_count": 0,
- "domain_controller": {
- "string": "string",
- "valid": true
}, - "version": "string",
- "user_sid": {
- "string": "string",
- "valid": true
}, - "type": "sharphound",
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
}
]
}Creates a client for collection events
| Prefer | integer [ 0 .. 60 ] Default: 30 Prefer header, used to specify a custom timeout in seconds using the wait parameter as per RFC7240. The default timeout is 30 seconds and maximum timeout is 60 seconds |
The request body for creating a client
| name | string |
| domain_controller | string |
| type | string (client-type) Enum: "sharphound" "azurehound" This enum describes the collector client type. |
Array of objects (client-schedule) |
{- "name": "string",
- "domain_controller": "string",
- "type": "sharphound",
- "events": [
- {
- "rrule": "string",
- "session_collection": true,
- "local_group_collection": true,
- "ad_structure_collection": true,
- "cert_services_collection": true,
- "ca_registry_collection": true,
- "dc_registry_collection": true,
- "all_trusted_domains": true,
- "ous": [
- "string"
], - "domains": [
- "string"
]
}
]
}{- "data": {
- "name": "string",
- "ip_address": "192.168.0.1",
- "hostname": "example.com",
- "configured_user": "string",
- "last_checkin": "2019-08-24T14:15:22Z",
- "events": [
- {
- "client_id": "5b3fa7ba-57d3-4017-a65b-d57dcd2db643",
- "rrule": "string",
- "session_collection": true,
- "local_group_collection": true,
- "ad_structure_collection": true,
- "cert_services_collection": true,
- "ca_registry_collection": true,
- "dc_registry_collection": true,
- "all_trusted_domains": true,
- "next_scheduled_at": "2019-08-24T14:15:22Z",
- "ous": [
- "string"
], - "domains": [
- "string"
], - "id": 0,
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z",
- "deleted_at": {
- "time": "2019-08-24T14:15:22Z",
- "valid": true
}
}
], - "token": {
- "user_id": {
- "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
- "valid": true
}, - "name": {
- "string": "string",
- "valid": true
}, - "key": "string",
- "hmac_method": "string",
- "last_access": "2019-08-24T14:15:22Z",
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z",
- "deleted_at": {
- "time": "2019-08-24T14:15:22Z",
- "valid": true
}
}, - "current_job_id": {
- "int64": 0,
- "valid": true
}, - "current_job": {
- "client_id": "5b3fa7ba-57d3-4017-a65b-d57dcd2db643",
- "client_name": "string",
- "event_id": {
- "int32": 0,
- "valid": true
}, - "status": -1,
- "statusMessage": "string",
- "start_time": "2019-08-24T14:15:22Z",
- "end_time": "2019-08-24T14:15:22Z",
- "log_path": {
- "string": "string",
- "valid": true
}, - "session_collection": true,
- "local_group_collection": true,
- "ad_structure_collection": true,
- "cert_services_collection": true,
- "ca_registry_collection": true,
- "dc_registry_collection": true,
- "all_trusted_domains": true,
- "domain_controller": {
- "string": "string",
- "valid": true
}, - "event_title": "string",
- "last_ingest": "2019-08-24T14:15:22Z",
- "ous": [
- "string"
], - "domains": [
- "string"
], - "domain_results": [
- {
- "job_id": 0,
- "domain_name": "string",
- "success": true,
- "message": "string",
- "user_count": 0,
- "group_count": 0,
- "computer_count": 0,
- "gpo_count": 0,
- "ou_count": 0,
- "container_count": 0,
- "aiaca_count": 0,
- "rootca_count": 0,
- "enterpriseca_count": 0,
- "ntauthstore_count": 0,
- "certtemplate_count": 0,
- "deleted_count": 0,
- "id": 0,
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z",
- "deleted_at": {
- "time": "2019-08-24T14:15:22Z",
- "valid": true
}
}
], - "id": 0,
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z",
- "deleted_at": {
- "time": "2019-08-24T14:15:22Z",
- "valid": true
}
}, - "completed_job_count": 0,
- "domain_controller": {
- "string": "string",
- "valid": true
}, - "version": "string",
- "user_sid": {
- "string": "string",
- "valid": true
}, - "type": "sharphound",
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z",
- "deleted_at": {
- "time": "2019-08-24T14:15:22Z",
- "valid": true
}
}
}Endpoint for clients to log enumeration errors.
Note: caller must be a client. For users, this endpoint will return a 404 as they are not expected or allowed to call this endpoint.
| Prefer | integer [ 0 .. 60 ] Default: 30 Prefer header, used to specify a custom timeout in seconds using the wait parameter as per RFC7240. The default timeout is 30 seconds and maximum timeout is 60 seconds |
The request body for logging a client enumeration error
| task_error | string |
object |
{- "task_error": "string",
- "additional": {
- "property1": "string",
- "property2": "string"
}
}[this request has no response data]
Endpoint for clients to update their own information at startup.
Note: caller must be a client. For users, this endpoint will return a 404 as they are not expected or allowed to call this endpoint.
| Prefer | integer [ 0 .. 60 ] Default: 30 Prefer header, used to specify a custom timeout in seconds using the wait parameter as per RFC7240. The default timeout is 30 seconds and maximum timeout is 60 seconds |
The request body for updating a client
| address | string |
| hostname | string |
| username | string |
| version | string |
| usersid | string |
{- "address": "string",
- "hostname": "string",
- "username": "string",
- "version": "string",
- "usersid": "string"
}{- "data": {
- "name": "string",
- "ip_address": "192.168.0.1",
- "hostname": "example.com",
- "configured_user": "string",
- "last_checkin": "2019-08-24T14:15:22Z",
- "events": [
- {
- "client_id": "5b3fa7ba-57d3-4017-a65b-d57dcd2db643",
- "rrule": "string",
- "session_collection": true,
- "local_group_collection": true,
- "ad_structure_collection": true,
- "cert_services_collection": true,
- "ca_registry_collection": true,
- "dc_registry_collection": true,
- "all_trusted_domains": true,
- "next_scheduled_at": "2019-08-24T14:15:22Z",
- "ous": [
- "string"
], - "domains": [
- "string"
], - "id": 0,
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z",
- "deleted_at": {
- "time": "2019-08-24T14:15:22Z",
- "valid": true
}
}
], - "token": {
- "user_id": {
- "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
- "valid": true
}, - "name": {
- "string": "string",
- "valid": true
}, - "key": "string",
- "hmac_method": "string",
- "last_access": "2019-08-24T14:15:22Z",
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z",
- "deleted_at": {
- "time": "2019-08-24T14:15:22Z",
- "valid": true
}
}, - "current_job_id": {
- "int64": 0,
- "valid": true
}, - "current_job": {
- "client_id": "5b3fa7ba-57d3-4017-a65b-d57dcd2db643",
- "client_name": "string",
- "event_id": {
- "int32": 0,
- "valid": true
}, - "status": -1,
- "statusMessage": "string",
- "start_time": "2019-08-24T14:15:22Z",
- "end_time": "2019-08-24T14:15:22Z",
- "log_path": {
- "string": "string",
- "valid": true
}, - "session_collection": true,
- "local_group_collection": true,
- "ad_structure_collection": true,
- "cert_services_collection": true,
- "ca_registry_collection": true,
- "dc_registry_collection": true,
- "all_trusted_domains": true,
- "domain_controller": {
- "string": "string",
- "valid": true
}, - "event_title": "string",
- "last_ingest": "2019-08-24T14:15:22Z",
- "ous": [
- "string"
], - "domains": [
- "string"
], - "domain_results": [
- {
- "job_id": 0,
- "domain_name": "string",
- "success": true,
- "message": "string",
- "user_count": 0,
- "group_count": 0,
- "computer_count": 0,
- "gpo_count": 0,
- "ou_count": 0,
- "container_count": 0,
- "aiaca_count": 0,
- "rootca_count": 0,
- "enterpriseca_count": 0,
- "ntauthstore_count": 0,
- "certtemplate_count": 0,
- "deleted_count": 0,
- "id": 0,
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z",
- "deleted_at": {
- "time": "2019-08-24T14:15:22Z",
- "valid": true
}
}
], - "id": 0,
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z",
- "deleted_at": {
- "time": "2019-08-24T14:15:22Z",
- "valid": true
}
}, - "completed_job_count": 0,
- "domain_controller": {
- "string": "string",
- "valid": true
}, - "version": "string",
- "user_sid": {
- "string": "string",
- "valid": true
}, - "type": "sharphound",
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z",
- "deleted_at": {
- "time": "2019-08-24T14:15:22Z",
- "valid": true
}
}
}Gets given client for processing collection events
| client_id required | string <uuid> Client ID |
| Prefer | integer [ 0 .. 60 ] Default: 30 Prefer header, used to specify a custom timeout in seconds using the wait parameter as per RFC7240. The default timeout is 30 seconds and maximum timeout is 60 seconds |
{- "data": {
- "name": "string",
- "ip_address": "192.168.0.1",
- "hostname": "string",
- "configured_user": "string",
- "last_checkin": "2019-08-24T14:15:22Z",
- "events": [
- {
- "client_id": "5b3fa7ba-57d3-4017-a65b-d57dcd2db643",
- "rrule": "string",
- "session_collection": true,
- "local_group_collection": true,
- "ad_structure_collection": true,
- "cert_services_collection": true,
- "ca_registry_collection": true,
- "dc_registry_collection": true,
- "all_trusted_domains": true,
- "ous": [
- {
- "distinguishedname": "string",
- "type": "string",
- "objectid": "string",
- "name": "string",
- "exists": true
}
], - "domains": [
- {
- "type": "string",
- "objectid": "string",
- "name": "string",
- "exists": true
}
], - "id": 0
}
], - "token": {
- "user_id": {
- "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
- "valid": true
}, - "name": {
- "string": "string",
- "valid": true
}, - "key": "string",
- "hmac_method": "string",
- "last_access": "2019-08-24T14:15:22Z",
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z",
- "deleted_at": {
- "time": "2019-08-24T14:15:22Z",
- "valid": true
}
}, - "current_job_id": {
- "int64": 0,
- "valid": true
}, - "current_task_id": {
- "int64": 0,
- "valid": true
}, - "current_job": {
- "client_id": "5b3fa7ba-57d3-4017-a65b-d57dcd2db643",
- "client_name": "string",
- "event_id": {
- "int32": 0,
- "valid": true
}, - "execution_time": "2019-08-24T14:15:22Z",
- "start_time": "2019-08-24T14:15:22Z",
- "end_time": "2019-08-24T14:15:22Z",
- "status": -1,
- "status_message": "string",
- "session_collection": true,
- "local_group_collection": true,
- "ad_structure_collection": true,
- "cert_services_collection": true,
- "ca_registry_collection": true,
- "dc_registry_collection": true,
- "all_trusted_domains": true,
- "domain_controller": "string",
- "ous": [
- {
- "distinguishedname": "string",
- "type": "string",
- "objectid": "string",
- "name": "string",
- "exists": true
}
], - "domains": [
- {
- "type": "string",
- "objectid": "string",
- "name": "string",
- "exists": true
}
], - "domain_results": [
- {
- "job_id": 0,
- "domain_name": "string",
- "success": true,
- "message": "string",
- "user_count": 0,
- "group_count": 0,
- "computer_count": 0,
- "gpo_count": 0,
- "ou_count": 0,
- "container_count": 0,
- "aiaca_count": 0,
- "rootca_count": 0,
- "enterpriseca_count": 0,
- "ntauthstore_count": 0,
- "certtemplate_count": 0,
- "deleted_count": 0,
- "id": 0,
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z",
- "deleted_at": {
- "time": "2019-08-24T14:15:22Z",
- "valid": true
}
}
], - "id": 0
}, - "current_task": {
- "client_id": "5b3fa7ba-57d3-4017-a65b-d57dcd2db643",
- "client_name": "string",
- "event_id": {
- "int32": 0,
- "valid": true
}, - "execution_time": "2019-08-24T14:15:22Z",
- "start_time": "2019-08-24T14:15:22Z",
- "end_time": "2019-08-24T14:15:22Z",
- "status": -1,
- "status_message": "string",
- "session_collection": true,
- "local_group_collection": true,
- "ad_structure_collection": true,
- "cert_services_collection": true,
- "ca_registry_collection": true,
- "dc_registry_collection": true,
- "all_trusted_domains": true,
- "domain_controller": "string",
- "ous": [
- {
- "distinguishedname": "string",
- "type": "string",
- "objectid": "string",
- "name": "string",
- "exists": true
}
], - "domains": [
- {
- "type": "string",
- "objectid": "string",
- "name": "string",
- "exists": true
}
], - "domain_results": [
- {
- "job_id": 0,
- "domain_name": "string",
- "success": true,
- "message": "string",
- "user_count": 0,
- "group_count": 0,
- "computer_count": 0,
- "gpo_count": 0,
- "ou_count": 0,
- "container_count": 0,
- "aiaca_count": 0,
- "rootca_count": 0,
- "enterpriseca_count": 0,
- "ntauthstore_count": 0,
- "certtemplate_count": 0,
- "deleted_count": 0,
- "id": 0,
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z",
- "deleted_at": {
- "time": "2019-08-24T14:15:22Z",
- "valid": true
}
}
], - "id": 0
}, - "completed_job_count": 0,
- "completed_task_count": 0,
- "domain_controller": {
- "string": "string",
- "valid": true
}, - "version": "string",
- "user_sid": {
- "string": "string",
- "valid": true
}, - "type": "sharphound",
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
}
}Update a client for processing collection events
| client_id required | string <uuid> Client ID |
| Prefer | integer [ 0 .. 60 ] Default: 30 Prefer header, used to specify a custom timeout in seconds using the wait parameter as per RFC7240. The default timeout is 30 seconds and maximum timeout is 60 seconds |
The request body for updating a client
| name | string |
| domain_controller | string |
{- "name": "string",
- "domain_controller": "string"
}{- "data": {
- "name": "string",
- "ip_address": "192.168.0.1",
- "hostname": "example.com",
- "configured_user": "string",
- "last_checkin": "2019-08-24T14:15:22Z",
- "events": [
- {
- "client_id": "5b3fa7ba-57d3-4017-a65b-d57dcd2db643",
- "rrule": "string",
- "session_collection": true,
- "local_group_collection": true,
- "ad_structure_collection": true,
- "cert_services_collection": true,
- "ca_registry_collection": true,
- "dc_registry_collection": true,
- "all_trusted_domains": true,
- "next_scheduled_at": "2019-08-24T14:15:22Z",
- "ous": [
- "string"
], - "domains": [
- "string"
], - "id": 0,
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z",
- "deleted_at": {
- "time": "2019-08-24T14:15:22Z",
- "valid": true
}
}
], - "token": {
- "user_id": {
- "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
- "valid": true
}, - "name": {
- "string": "string",
- "valid": true
}, - "key": "string",
- "hmac_method": "string",
- "last_access": "2019-08-24T14:15:22Z",
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z",
- "deleted_at": {
- "time": "2019-08-24T14:15:22Z",
- "valid": true
}
}, - "current_job_id": {
- "int64": 0,
- "valid": true
}, - "current_job": {
- "client_id": "5b3fa7ba-57d3-4017-a65b-d57dcd2db643",
- "client_name": "string",
- "event_id": {
- "int32": 0,
- "valid": true
}, - "status": -1,
- "statusMessage": "string",
- "start_time": "2019-08-24T14:15:22Z",
- "end_time": "2019-08-24T14:15:22Z",
- "log_path": {
- "string": "string",
- "valid": true
}, - "session_collection": true,
- "local_group_collection": true,
- "ad_structure_collection": true,
- "cert_services_collection": true,
- "ca_registry_collection": true,
- "dc_registry_collection": true,
- "all_trusted_domains": true,
- "domain_controller": {
- "string": "string",
- "valid": true
}, - "event_title": "string",
- "last_ingest": "2019-08-24T14:15:22Z",
- "ous": [
- "string"
], - "domains": [
- "string"
], - "domain_results": [
- {
- "job_id": 0,
- "domain_name": "string",
- "success": true,
- "message": "string",
- "user_count": 0,
- "group_count": 0,
- "computer_count": 0,
- "gpo_count": 0,
- "ou_count": 0,
- "container_count": 0,
- "aiaca_count": 0,
- "rootca_count": 0,
- "enterpriseca_count": 0,
- "ntauthstore_count": 0,
- "certtemplate_count": 0,
- "deleted_count": 0,
- "id": 0,
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z",
- "deleted_at": {
- "time": "2019-08-24T14:15:22Z",
- "valid": true
}
}
], - "id": 0,
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z",
- "deleted_at": {
- "time": "2019-08-24T14:15:22Z",
- "valid": true
}
}, - "completed_job_count": 0,
- "domain_controller": {
- "string": "string",
- "valid": true
}, - "version": "string",
- "user_sid": {
- "string": "string",
- "valid": true
}, - "type": "sharphound",
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z",
- "deleted_at": {
- "time": "2019-08-24T14:15:22Z",
- "valid": true
}
}
}Delete a client for processing collection events
| client_id required | string <uuid> Client ID |
| Prefer | integer [ 0 .. 60 ] Default: 30 Prefer header, used to specify a custom timeout in seconds using the wait parameter as per RFC7240. The default timeout is 30 seconds and maximum timeout is 60 seconds |
[this request has no response data]
Regenerate the authentication token for a client
| client_id required | string <uuid> Client ID |
| Prefer | integer [ 0 .. 60 ] Default: 30 Prefer header, used to specify a custom timeout in seconds using the wait parameter as per RFC7240. The default timeout is 30 seconds and maximum timeout is 60 seconds |
{- "data": {
- "user_id": {
- "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
- "valid": true
}, - "name": {
- "string": "string",
- "valid": true
}, - "key": "string",
- "hmac_method": "string",
- "last_access": "2019-08-24T14:15:22Z",
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z",
- "deleted_at": {
- "time": "2019-08-24T14:15:22Z",
- "valid": true
}
}
}List all completed tasks for a client
| client_id required | string <uuid> Client ID |
| created_at | string <date-time> (filter.time) Filter results by |
| updated_at | string <date-time> (filter.time) Filter results by |
| deleted_at | string <date-time> (filter.time) Filter results by |
| hydrate_domains | boolean Default: true When a value of |
| hydrate_ous | boolean Default: true When a value of |
| skip | integer (skip) >= 0 This query parameter is used for determining the number of objects to skip in pagination. |
| limit | integer (limit) >= 0 This query parameter is used for setting an upper limit of objects returned in paginated responses. |
| sort_by | string (sort-by) Sortable columns are |
| id | integer (filter.integer) Filter results by column integer value. Valid filter predicates are |
| log_path | string (filter.string) Filter results by column string value. Valid filter predicates are |
| session_collection | boolean (filter.boolean) Filter results by column boolean value. Valid filter predicates are |
| local_group_collection | boolean (filter.boolean) Filter results by column boolean value. Valid filter predicates are |
| cert_services_collection | boolean (filter.boolean) Filter results by column boolean value. Valid filter predicates are |
| ca_registry_collection | boolean (filter.boolean) Filter results by column boolean value. Valid filter predicates are |
| dc_registry_collection | boolean (filter.boolean) Filter results by column boolean value. Valid filter predicates are |
| ad_structure_collection | boolean (filter.boolean) Filter results by column boolean value. Valid filter predicates are |
| domain_controller | string (filter.string) Filter results by column string value. Valid filter predicates are |
| status | string (filter.string) Filter results by column string value. Valid filter predicates are |
| event_title | string (filter.string) Filter results by column string value. Valid filter predicates are |
| client_id | string <uuid> (filter.uuid) Filter results by column string-formatted uuid value. Valid filter predicates are |
| event_id | integer (filter.integer) Filter results by column integer value. Valid filter predicates are |
| execution_time | string <date-time> (filter.time) Filter results by column timestamp value formatted as an RFC-3339 string.
Valid filter predicates are |
| start_time | string <date-time> (filter.time) Filter results by column timestamp value formatted as an RFC-3339 string.
Valid filter predicates are |
| end_time | string <date-time> (filter.time) Filter results by column timestamp value formatted as an RFC-3339 string.
Valid filter predicates are |
| last_ingest | string <date-time> (filter.time) Filter results by column timestamp value formatted as an RFC-3339 string.
Valid filter predicates are |
| Prefer | integer [ 0 .. 60 ] Default: 30 Prefer header, used to specify a custom timeout in seconds using the wait parameter as per RFC7240. The default timeout is 30 seconds and maximum timeout is 60 seconds |
{- "count": 0,
- "skip": 0,
- "limit": 0,
- "data": [
- {
- "client_id": "5b3fa7ba-57d3-4017-a65b-d57dcd2db643",
- "client_name": "string",
- "event_id": {
- "int32": 0,
- "valid": true
}, - "execution_time": "2019-08-24T14:15:22Z",
- "start_time": "2019-08-24T14:15:22Z",
- "end_time": "2019-08-24T14:15:22Z",
- "status": -1,
- "status_message": "string",
- "session_collection": true,
- "local_group_collection": true,
- "ad_structure_collection": true,
- "cert_services_collection": true,
- "ca_registry_collection": true,
- "dc_registry_collection": true,
- "all_trusted_domains": true,
- "domain_controller": "string",
- "ous": [
- {
- "distinguishedname": "string",
- "type": "string",
- "objectid": "string",
- "name": "string",
- "exists": true
}
], - "domains": [
- {
- "type": "string",
- "objectid": "string",
- "name": "string",
- "exists": true
}
], - "domain_results": [
- {
- "job_id": 0,
- "domain_name": "string",
- "success": true,
- "message": "string",
- "user_count": 0,
- "group_count": 0,
- "computer_count": 0,
- "gpo_count": 0,
- "ou_count": 0,
- "container_count": 0,
- "aiaca_count": 0,
- "rootca_count": 0,
- "enterpriseca_count": 0,
- "ntauthstore_count": 0,
- "certtemplate_count": 0,
- "deleted_count": 0,
- "id": 0,
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z",
- "deleted_at": {
- "time": "2019-08-24T14:15:22Z",
- "valid": true
}
}
], - "id": 0
}
]
}List all completed jobs for a client
| client_id required | string <uuid> Client ID |
| created_at | string <date-time> (filter.time) Filter results by |
| updated_at | string <date-time> (filter.time) Filter results by |
| deleted_at | string <date-time> (filter.time) Filter results by |
| hydrate_domains | boolean Default: true When a value of |
| hydrate_ous | boolean Default: true When a value of |
| skip | integer (skip) >= 0 This query parameter is used for determining the number of objects to skip in pagination. |
| limit | integer (limit) >= 0 This query parameter is used for setting an upper limit of objects returned in paginated responses. |
| sort_by | string (sort-by) Sortable columns are |
| id | integer (filter.integer) Filter results by column integer value. Valid filter predicates are |
| log_path | string (filter.string) Filter results by column string value. Valid filter predicates are |
| session_collection | boolean (filter.boolean) Filter results by column boolean value. Valid filter predicates are |
| local_group_collection | boolean (filter.boolean) Filter results by column boolean value. Valid filter predicates are |
| cert_services_collection | boolean (filter.boolean) Filter results by column boolean value. Valid filter predicates are |
| ca_registry_collection | boolean (filter.boolean) Filter results by column boolean value. Valid filter predicates are |
| dc_registry_collection | boolean (filter.boolean) Filter results by column boolean value. Valid filter predicates are |
| ad_structure_collection | boolean (filter.boolean) Filter results by column boolean value. Valid filter predicates are |
| domain_controller | string (filter.string) Filter results by column string value. Valid filter predicates are |
| status | string (filter.string) Filter results by column string value. Valid filter predicates are |
| event_title | string (filter.string) Filter results by column string value. Valid filter predicates are |
| client_id | string <uuid> (filter.uuid) Filter results by column string-formatted uuid value. Valid filter predicates are |
| event_id | integer (filter.integer) Filter results by column integer value. Valid filter predicates are |
| execution_time | string <date-time> (filter.time) Filter results by column timestamp value formatted as an RFC-3339 string.
Valid filter predicates are |
| start_time | string <date-time> (filter.time) Filter results by column timestamp value formatted as an RFC-3339 string.
Valid filter predicates are |
| end_time | string <date-time> (filter.time) Filter results by column timestamp value formatted as an RFC-3339 string.
Valid filter predicates are |
| last_ingest | string <date-time> (filter.time) Filter results by column timestamp value formatted as an RFC-3339 string.
Valid filter predicates are |
| Prefer | integer [ 0 .. 60 ] Default: 30 Prefer header, used to specify a custom timeout in seconds using the wait parameter as per RFC7240. The default timeout is 30 seconds and maximum timeout is 60 seconds |
{- "count": 0,
- "skip": 0,
- "limit": 0,
- "data": [
- {
- "client_id": "5b3fa7ba-57d3-4017-a65b-d57dcd2db643",
- "client_name": "string",
- "event_id": {
- "int32": 0,
- "valid": true
}, - "execution_time": "2019-08-24T14:15:22Z",
- "start_time": "2019-08-24T14:15:22Z",
- "end_time": "2019-08-24T14:15:22Z",
- "status": -1,
- "status_message": "string",
- "session_collection": true,
- "local_group_collection": true,
- "ad_structure_collection": true,
- "cert_services_collection": true,
- "ca_registry_collection": true,
- "dc_registry_collection": true,
- "all_trusted_domains": true,
- "domain_controller": "string",
- "ous": [
- {
- "distinguishedname": "string",
- "type": "string",
- "objectid": "string",
- "name": "string",
- "exists": true
}
], - "domains": [
- {
- "type": "string",
- "objectid": "string",
- "name": "string",
- "exists": true
}
], - "domain_results": [
- {
- "job_id": 0,
- "domain_name": "string",
- "success": true,
- "message": "string",
- "user_count": 0,
- "group_count": 0,
- "computer_count": 0,
- "gpo_count": 0,
- "ou_count": 0,
- "container_count": 0,
- "aiaca_count": 0,
- "rootca_count": 0,
- "enterpriseca_count": 0,
- "ntauthstore_count": 0,
- "certtemplate_count": 0,
- "deleted_count": 0,
- "id": 0,
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z",
- "deleted_at": {
- "time": "2019-08-24T14:15:22Z",
- "valid": true
}
}
], - "id": 0
}
]
}Creates a new scheduled task
| client_id required | string <uuid> Client ID |
| Prefer | integer [ 0 .. 60 ] Default: 30 Prefer header, used to specify a custom timeout in seconds using the wait parameter as per RFC7240. The default timeout is 30 seconds and maximum timeout is 60 seconds |
The request body for creating a scheduled task
| session_collection | boolean |
| local_group_collection | boolean |
| ad_structure_collection | boolean |
| cert_services_collection | boolean |
| ca_registry_collection | boolean |
| dc_registry_collection | boolean |
| all_trusted_domains | boolean |
object (string) |
{- "session_collection": true,
- "local_group_collection": true,
- "ad_structure_collection": true,
- "cert_services_collection": true,
- "ca_registry_collection": true,
- "dc_registry_collection": true,
- "all_trusted_domains": true,
- "domain_controller": {
- "string": "string",
- "valid": true
}
}{- "data": {
- "client_id": "5b3fa7ba-57d3-4017-a65b-d57dcd2db643",
- "client_name": "string",
- "event_id": {
- "int32": 0,
- "valid": true
}, - "status": -1,
- "statusMessage": "string",
- "start_time": "2019-08-24T14:15:22Z",
- "end_time": "2019-08-24T14:15:22Z",
- "log_path": {
- "string": "string",
- "valid": true
}, - "session_collection": true,
- "local_group_collection": true,
- "ad_structure_collection": true,
- "cert_services_collection": true,
- "ca_registry_collection": true,
- "dc_registry_collection": true,
- "all_trusted_domains": true,
- "domain_controller": {
- "string": "string",
- "valid": true
}, - "event_title": "string",
- "last_ingest": "2019-08-24T14:15:22Z",
- "ous": [
- "string"
], - "domains": [
- "string"
], - "domain_results": [
- {
- "job_id": 0,
- "domain_name": "string",
- "success": true,
- "message": "string",
- "user_count": 0,
- "group_count": 0,
- "computer_count": 0,
- "gpo_count": 0,
- "ou_count": 0,
- "container_count": 0,
- "aiaca_count": 0,
- "rootca_count": 0,
- "enterpriseca_count": 0,
- "ntauthstore_count": 0,
- "certtemplate_count": 0,
- "deleted_count": 0,
- "id": 0,
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z",
- "deleted_at": {
- "time": "2019-08-24T14:15:22Z",
- "valid": true
}
}
], - "id": 0,
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z",
- "deleted_at": {
- "time": "2019-08-24T14:15:22Z",
- "valid": true
}
}
}Creates a new scheduled job
| client_id required | string <uuid> Client ID |
| Prefer | integer [ 0 .. 60 ] Default: 30 Prefer header, used to specify a custom timeout in seconds using the wait parameter as per RFC7240. The default timeout is 30 seconds and maximum timeout is 60 seconds |
The request body for creating a scheduled job
| session_collection | boolean |
| local_group_collection | boolean |
| ad_structure_collection | boolean |
| cert_services_collection | boolean |
| ca_registry_collection | boolean |
| dc_registry_collection | boolean |
| all_trusted_domains | boolean |
object (string) |
{- "session_collection": true,
- "local_group_collection": true,
- "ad_structure_collection": true,
- "cert_services_collection": true,
- "ca_registry_collection": true,
- "dc_registry_collection": true,
- "all_trusted_domains": true,
- "domain_controller": {
- "string": "string",
- "valid": true
}
}{- "data": {
- "client_id": "5b3fa7ba-57d3-4017-a65b-d57dcd2db643",
- "client_name": "string",
- "event_id": {
- "int32": 0,
- "valid": true
}, - "status": -1,
- "statusMessage": "string",
- "start_time": "2019-08-24T14:15:22Z",
- "end_time": "2019-08-24T14:15:22Z",
- "log_path": {
- "string": "string",
- "valid": true
}, - "session_collection": true,
- "local_group_collection": true,
- "ad_structure_collection": true,
- "cert_services_collection": true,
- "ca_registry_collection": true,
- "dc_registry_collection": true,
- "all_trusted_domains": true,
- "domain_controller": {
- "string": "string",
- "valid": true
}, - "event_title": "string",
- "last_ingest": "2019-08-24T14:15:22Z",
- "ous": [
- "string"
], - "domains": [
- "string"
], - "domain_results": [
- {
- "job_id": 0,
- "domain_name": "string",
- "success": true,
- "message": "string",
- "user_count": 0,
- "group_count": 0,
- "computer_count": 0,
- "gpo_count": 0,
- "ou_count": 0,
- "container_count": 0,
- "aiaca_count": 0,
- "rootca_count": 0,
- "enterpriseca_count": 0,
- "ntauthstore_count": 0,
- "certtemplate_count": 0,
- "deleted_count": 0,
- "id": 0,
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z",
- "deleted_at": {
- "time": "2019-08-24T14:15:22Z",
- "valid": true
}
}
], - "id": 0,
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z",
- "deleted_at": {
- "time": "2019-08-24T14:15:22Z",
- "valid": true
}
}
}Endpoint for clients to get next available jobs.
Note: caller must be a client. For users, this endpoint will return a 404 as they are not expected or allowed to call this endpoint.
| sort_by | string (sort-by) Sortable columns are |
| log_path | string (filter.string) Filter results by column string value. Valid filter predicates are |
| session_collection | boolean (filter.boolean) Filter results by column boolean value. Valid filter predicates are |
| local_group_collection | boolean (filter.boolean) Filter results by column boolean value. Valid filter predicates are |
| cert_services_collection | boolean (filter.boolean) Filter results by column boolean value. Valid filter predicates are |
| ca_registry_collection | boolean (filter.boolean) Filter results by column boolean value. Valid filter predicates are |
| dc_registry_collection | boolean (filter.boolean) Filter results by column boolean value. Valid filter predicates are |
| ad_structure_collection | boolean (filter.boolean) Filter results by column boolean value. Valid filter predicates are |
| domain_controller | string (filter.string) Filter results by column string value. Valid filter predicates are |
| status | string (filter.string) Filter results by column string value. Valid filter predicates are |
| event_title | string (filter.string) Filter results by column string value. Valid filter predicates are |
| client_id | string <uuid> (filter.uuid) Filter results by column string-formatted uuid value. Valid filter predicates are |
| event_id | integer (filter.integer) Filter results by column integer value. Valid filter predicates are |
| execution_time | string <date-time> (filter.time) Filter results by column timestamp value formatted as an RFC-3339 string.
Valid filter predicates are |
| start_time | string <date-time> (filter.time) Filter results by column timestamp value formatted as an RFC-3339 string.
Valid filter predicates are |
| end_time | string <date-time> (filter.time) Filter results by column timestamp value formatted as an RFC-3339 string.
Valid filter predicates are |
| last_ingest | string <date-time> (filter.time) Filter results by column timestamp value formatted as an RFC-3339 string.
Valid filter predicates are |
| hydrate_ous | boolean Default: true When a value of |
| hydrate_domains | boolean Default: true When a value of |
| created_at | string <date-time> (filter.time) Filter results by |
| updated_at | string <date-time> (filter.time) Filter results by |
| deleted_at | string <date-time> (filter.time) Filter results by |
| Prefer | integer [ 0 .. 60 ] Default: 30 Prefer header, used to specify a custom timeout in seconds using the wait parameter as per RFC7240. The default timeout is 30 seconds and maximum timeout is 60 seconds |
{- "data": [
- {
- "client_id": "5b3fa7ba-57d3-4017-a65b-d57dcd2db643",
- "client_name": "string",
- "event_id": {
- "int32": 0,
- "valid": true
}, - "execution_time": "2019-08-24T14:15:22Z",
- "start_time": "2019-08-24T14:15:22Z",
- "end_time": "2019-08-24T14:15:22Z",
- "status": -1,
- "status_message": "string",
- "session_collection": true,
- "local_group_collection": true,
- "ad_structure_collection": true,
- "cert_services_collection": true,
- "ca_registry_collection": true,
- "dc_registry_collection": true,
- "all_trusted_domains": true,
- "domain_controller": "string",
- "ous": [
- {
- "distinguishedname": "string",
- "type": "string",
- "objectid": "string",
- "name": "string",
- "exists": true
}
], - "domains": [
- {
- "type": "string",
- "objectid": "string",
- "name": "string",
- "exists": true
}
], - "domain_results": [
- {
- "job_id": 0,
- "domain_name": "string",
- "success": true,
- "message": "string",
- "user_count": 0,
- "group_count": 0,
- "computer_count": 0,
- "gpo_count": 0,
- "ou_count": 0,
- "container_count": 0,
- "aiaca_count": 0,
- "rootca_count": 0,
- "enterpriseca_count": 0,
- "ntauthstore_count": 0,
- "certtemplate_count": 0,
- "deleted_count": 0,
- "id": 0,
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z",
- "deleted_at": {
- "time": "2019-08-24T14:15:22Z",
- "valid": true
}
}
], - "id": 0
}
]
}Gets all finished jobs
| sort_by | string (sort-by) Sortable columns are |
| log_path | string (filter.string) Filter results by column string value. Valid filter predicates are |
| session_collection | boolean (filter.boolean) Filter results by column boolean value. Valid filter predicates are |
| local_group_collection | boolean (filter.boolean) Filter results by column boolean value. Valid filter predicates are |
| cert_services_collection | boolean (filter.boolean) Filter results by column boolean value. Valid filter predicates are |
| ca_registry_collection | boolean (filter.boolean) Filter results by column boolean value. Valid filter predicates are |
| dc_registry_collection | boolean (filter.boolean) Filter results by column boolean value. Valid filter predicates are |
| ad_structure_collection | boolean (filter.boolean) Filter results by column boolean value. Valid filter predicates are |
| domain_controller | string (filter.string) Filter results by column string value. Valid filter predicates are |
| status | string (filter.string) Filter results by column string value. Valid filter predicates are |
| event_title | string (filter.string) Filter results by column string value. Valid filter predicates are |
| client_id | string <uuid> (filter.uuid) Filter results by column string-formatted uuid value. Valid filter predicates are |
| event_id | integer (filter.integer) Filter results by column integer value. Valid filter predicates are |
| execution_time | string <date-time> (filter.time) Filter results by column timestamp value formatted as an RFC-3339 string.
Valid filter predicates are |
| start_time | string <date-time> (filter.time) Filter results by column timestamp value formatted as an RFC-3339 string.
Valid filter predicates are |
| end_time | string <date-time> (filter.time) Filter results by column timestamp value formatted as an RFC-3339 string.
Valid filter predicates are |
| last_ingest | string <date-time> (filter.time) Filter results by column timestamp value formatted as an RFC-3339 string.
Valid filter predicates are |
| hydrate_domains | boolean Default: true When a value of |
| hydrate_ous | boolean Default: true When a value of |
| created_at | string <date-time> (filter.time) Filter results by |
| updated_at | string <date-time> (filter.time) Filter results by |
| deleted_at | string <date-time> (filter.time) Filter results by |
| skip | integer (skip) >= 0 This query parameter is used for determining the number of objects to skip in pagination. |
| limit | integer (limit) >= 0 This query parameter is used for setting an upper limit of objects returned in paginated responses. |
| Prefer | integer [ 0 .. 60 ] Default: 30 Prefer header, used to specify a custom timeout in seconds using the wait parameter as per RFC7240. The default timeout is 30 seconds and maximum timeout is 60 seconds |
{- "count": 0,
- "skip": 0,
- "limit": 0,
- "data": [
- {
- "client_id": "5b3fa7ba-57d3-4017-a65b-d57dcd2db643",
- "client_name": "string",
- "event_id": {
- "int32": 0,
- "valid": true
}, - "execution_time": "2019-08-24T14:15:22Z",
- "start_time": "2019-08-24T14:15:22Z",
- "end_time": "2019-08-24T14:15:22Z",
- "status": -1,
- "status_message": "string",
- "session_collection": true,
- "local_group_collection": true,
- "ad_structure_collection": true,
- "cert_services_collection": true,
- "ca_registry_collection": true,
- "dc_registry_collection": true,
- "all_trusted_domains": true,
- "domain_controller": "string",
- "ous": [
- {
- "distinguishedname": "string",
- "type": "string",
- "objectid": "string",
- "name": "string",
- "exists": true
}
], - "domains": [
- {
- "type": "string",
- "objectid": "string",
- "name": "string",
- "exists": true
}
], - "domain_results": [
- {
- "job_id": 0,
- "domain_name": "string",
- "success": true,
- "message": "string",
- "user_count": 0,
- "group_count": 0,
- "computer_count": 0,
- "gpo_count": 0,
- "ou_count": 0,
- "container_count": 0,
- "aiaca_count": 0,
- "rootca_count": 0,
- "enterpriseca_count": 0,
- "ntauthstore_count": 0,
- "certtemplate_count": 0,
- "deleted_count": 0,
- "id": 0,
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z",
- "deleted_at": {
- "time": "2019-08-24T14:15:22Z",
- "valid": true
}
}
], - "id": 0
}
]
}Gets client jobs
| sort_by | string (sort-by) Sortable columns are |
| log_path | string (filter.string) Filter results by column string value. Valid filter predicates are |
| session_collection | boolean (filter.boolean) Filter results by column boolean value. Valid filter predicates are |
| local_group_collection | boolean (filter.boolean) Filter results by column boolean value. Valid filter predicates are |
| cert_services_collection | boolean (filter.boolean) Filter results by column boolean value. Valid filter predicates are |
| ca_registry_collection | boolean (filter.boolean) Filter results by column boolean value. Valid filter predicates are |
| dc_registry_collection | boolean (filter.boolean) Filter results by column boolean value. Valid filter predicates are |
| ad_structure_collection | boolean (filter.boolean) Filter results by column boolean value. Valid filter predicates are |
| domain_controller | string (filter.string) Filter results by column string value. Valid filter predicates are |
| status | string (filter.string) Filter results by column string value. Valid filter predicates are |
| event_title | string (filter.string) Filter results by column string value. Valid filter predicates are |
| client_id | string <uuid> (filter.uuid) Filter results by column string-formatted uuid value. Valid filter predicates are |
| event_id | integer (filter.integer) Filter results by column integer value. Valid filter predicates are |
| execution_time | string <date-time> (filter.time) Filter results by column timestamp value formatted as an RFC-3339 string.
Valid filter predicates are |
| start_time | string <date-time> (filter.time) Filter results by column timestamp value formatted as an RFC-3339 string.
Valid filter predicates are |
| end_time | string <date-time> (filter.time) Filter results by column timestamp value formatted as an RFC-3339 string.
Valid filter predicates are |
| last_ingest | string <date-time> (filter.time) Filter results by column timestamp value formatted as an RFC-3339 string.
Valid filter predicates are |
| created_at | string <date-time> (filter.time) Filter results by |
| updated_at | string <date-time> (filter.time) Filter results by |
| deleted_at | string <date-time> (filter.time) Filter results by |
| Prefer | integer [ 0 .. 60 ] Default: 30 Prefer header, used to specify a custom timeout in seconds using the wait parameter as per RFC7240. The default timeout is 30 seconds and maximum timeout is 60 seconds |
{- "data": [
- {
- "client_id": "5b3fa7ba-57d3-4017-a65b-d57dcd2db643",
- "client_name": "string",
- "event_id": {
- "int32": 0,
- "valid": true
}, - "execution_time": "2019-08-24T14:15:22Z",
- "start_time": "2019-08-24T14:15:22Z",
- "end_time": "2019-08-24T14:15:22Z",
- "status": -1,
- "status_message": "string",
- "session_collection": true,
- "local_group_collection": true,
- "ad_structure_collection": true,
- "cert_services_collection": true,
- "ca_registry_collection": true,
- "dc_registry_collection": true,
- "all_trusted_domains": true,
- "domain_controller": "string",
- "ous": [
- {
- "distinguishedname": "string",
- "type": "string",
- "objectid": "string",
- "name": "string",
- "exists": true
}
], - "domains": [
- {
- "type": "string",
- "objectid": "string",
- "name": "string",
- "exists": true
}
], - "domain_results": [
- {
- "job_id": 0,
- "domain_name": "string",
- "success": true,
- "message": "string",
- "user_count": 0,
- "group_count": 0,
- "computer_count": 0,
- "gpo_count": 0,
- "ou_count": 0,
- "container_count": 0,
- "aiaca_count": 0,
- "rootca_count": 0,
- "enterpriseca_count": 0,
- "ntauthstore_count": 0,
- "certtemplate_count": 0,
- "deleted_count": 0,
- "id": 0,
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z",
- "deleted_at": {
- "time": "2019-08-24T14:15:22Z",
- "valid": true
}
}
], - "id": 0
}
]
}Gets the current job for the authenticated client.
Note: caller must be a client. For users, this endpoint will return a 404 as they are not expected or allowed to call this endpoint.
| Prefer | integer [ 0 .. 60 ] Default: 30 Prefer header, used to specify a custom timeout in seconds using the wait parameter as per RFC7240. The default timeout is 30 seconds and maximum timeout is 60 seconds |
{- "data": {
- "client_id": "5b3fa7ba-57d3-4017-a65b-d57dcd2db643",
- "client_name": "string",
- "event_id": {
- "int32": 0,
- "valid": true
}, - "execution_time": "2019-08-24T14:15:22Z",
- "start_time": "2019-08-24T14:15:22Z",
- "end_time": "2019-08-24T14:15:22Z",
- "status": -1,
- "status_message": "string",
- "session_collection": true,
- "local_group_collection": true,
- "ad_structure_collection": true,
- "cert_services_collection": true,
- "ca_registry_collection": true,
- "dc_registry_collection": true,
- "all_trusted_domains": true,
- "domain_controller": "string",
- "ous": [
- {
- "distinguishedname": "string",
- "type": "string",
- "objectid": "string",
- "name": "string",
- "exists": true
}
], - "domains": [
- {
- "type": "string",
- "objectid": "string",
- "name": "string",
- "exists": true
}
], - "domain_results": [
- {
- "job_id": 0,
- "domain_name": "string",
- "success": true,
- "message": "string",
- "user_count": 0,
- "group_count": 0,
- "computer_count": 0,
- "gpo_count": 0,
- "ou_count": 0,
- "container_count": 0,
- "aiaca_count": 0,
- "rootca_count": 0,
- "enterpriseca_count": 0,
- "ntauthstore_count": 0,
- "certtemplate_count": 0,
- "deleted_count": 0,
- "id": 0,
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z",
- "deleted_at": {
- "time": "2019-08-24T14:15:22Z",
- "valid": true
}
}
], - "id": 0
}
}Endpoint for clients to start a new job and mark the start time.
Note: caller must be a client. For users, this endpoint will return a 404 as they are not expected or allowed to call this endpoint.
| Prefer | integer [ 0 .. 60 ] Default: 30 Prefer header, used to specify a custom timeout in seconds using the wait parameter as per RFC7240. The default timeout is 30 seconds and maximum timeout is 60 seconds |
| id | integer <int64> |
{- "id": 0
}{- "data": {
- "client_id": "5b3fa7ba-57d3-4017-a65b-d57dcd2db643",
- "client_name": "string",
- "event_id": {
- "int32": 0,
- "valid": true
}, - "status": -1,
- "statusMessage": "string",
- "start_time": "2019-08-24T14:15:22Z",
- "end_time": "2019-08-24T14:15:22Z",
- "log_path": {
- "string": "string",
- "valid": true
}, - "session_collection": true,
- "local_group_collection": true,
- "ad_structure_collection": true,
- "cert_services_collection": true,
- "ca_registry_collection": true,
- "dc_registry_collection": true,
- "all_trusted_domains": true,
- "domain_controller": {
- "string": "string",
- "valid": true
}, - "event_title": "string",
- "last_ingest": "2019-08-24T14:15:22Z",
- "ous": [
- "string"
], - "domains": [
- "string"
], - "domain_results": [
- {
- "job_id": 0,
- "domain_name": "string",
- "success": true,
- "message": "string",
- "user_count": 0,
- "group_count": 0,
- "computer_count": 0,
- "gpo_count": 0,
- "ou_count": 0,
- "container_count": 0,
- "aiaca_count": 0,
- "rootca_count": 0,
- "enterpriseca_count": 0,
- "ntauthstore_count": 0,
- "certtemplate_count": 0,
- "deleted_count": 0,
- "id": 0,
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z",
- "deleted_at": {
- "time": "2019-08-24T14:15:22Z",
- "valid": true
}
}
], - "id": 0,
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z",
- "deleted_at": {
- "time": "2019-08-24T14:15:22Z",
- "valid": true
}
}
}Endpoint for clients to end a job and mark the end time.
Note: caller must be a client. For users, this endpoint will return a 404 as they are not expected or allowed to call this endpoint.
| Prefer | integer [ 0 .. 60 ] Default: 30 Prefer header, used to specify a custom timeout in seconds using the wait parameter as per RFC7240. The default timeout is 30 seconds and maximum timeout is 60 seconds |
{- "data": {
- "client_id": "5b3fa7ba-57d3-4017-a65b-d57dcd2db643",
- "client_name": "string",
- "event_id": {
- "int32": 0,
- "valid": true
}, - "status": -1,
- "statusMessage": "string",
- "start_time": "2019-08-24T14:15:22Z",
- "end_time": "2019-08-24T14:15:22Z",
- "log_path": {
- "string": "string",
- "valid": true
}, - "session_collection": true,
- "local_group_collection": true,
- "ad_structure_collection": true,
- "cert_services_collection": true,
- "ca_registry_collection": true,
- "dc_registry_collection": true,
- "all_trusted_domains": true,
- "domain_controller": {
- "string": "string",
- "valid": true
}, - "event_title": "string",
- "last_ingest": "2019-08-24T14:15:22Z",
- "ous": [
- "string"
], - "domains": [
- "string"
], - "domain_results": [
- {
- "job_id": 0,
- "domain_name": "string",
- "success": true,
- "message": "string",
- "user_count": 0,
- "group_count": 0,
- "computer_count": 0,
- "gpo_count": 0,
- "ou_count": 0,
- "container_count": 0,
- "aiaca_count": 0,
- "rootca_count": 0,
- "enterpriseca_count": 0,
- "ntauthstore_count": 0,
- "certtemplate_count": 0,
- "deleted_count": 0,
- "id": 0,
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z",
- "deleted_at": {
- "time": "2019-08-24T14:15:22Z",
- "valid": true
}
}
], - "id": 0,
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z",
- "deleted_at": {
- "time": "2019-08-24T14:15:22Z",
- "valid": true
}
}
}Gets client job
| job_id required | integer <int64> Job ID |
| Prefer | integer [ 0 .. 60 ] Default: 30 Prefer header, used to specify a custom timeout in seconds using the wait parameter as per RFC7240. The default timeout is 30 seconds and maximum timeout is 60 seconds |
{- "data": {
- "client_id": "5b3fa7ba-57d3-4017-a65b-d57dcd2db643",
- "client_name": "string",
- "event_id": {
- "int32": 0,
- "valid": true
}, - "execution_time": "2019-08-24T14:15:22Z",
- "start_time": "2019-08-24T14:15:22Z",
- "end_time": "2019-08-24T14:15:22Z",
- "status": -1,
- "status_message": "string",
- "session_collection": true,
- "local_group_collection": true,
- "ad_structure_collection": true,
- "cert_services_collection": true,
- "ca_registry_collection": true,
- "dc_registry_collection": true,
- "all_trusted_domains": true,
- "domain_controller": "string",
- "ous": [
- {
- "distinguishedname": "string",
- "type": "string",
- "objectid": "string",
- "name": "string",
- "exists": true
}
], - "domains": [
- {
- "type": "string",
- "objectid": "string",
- "name": "string",
- "exists": true
}
], - "domain_results": [
- {
- "job_id": 0,
- "domain_name": "string",
- "success": true,
- "message": "string",
- "user_count": 0,
- "group_count": 0,
- "computer_count": 0,
- "gpo_count": 0,
- "ou_count": 0,
- "container_count": 0,
- "aiaca_count": 0,
- "rootca_count": 0,
- "enterpriseca_count": 0,
- "ntauthstore_count": 0,
- "certtemplate_count": 0,
- "deleted_count": 0,
- "id": 0,
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z",
- "deleted_at": {
- "time": "2019-08-24T14:15:22Z",
- "valid": true
}
}
], - "id": 0
}
}Cancels a scheduled job
| job_id required | integer <int64> Job ID |
| Prefer | integer [ 0 .. 60 ] Default: 30 Prefer header, used to specify a custom timeout in seconds using the wait parameter as per RFC7240. The default timeout is 30 seconds and maximum timeout is 60 seconds |
{- "data": {
- "client_id": "5b3fa7ba-57d3-4017-a65b-d57dcd2db643",
- "client_name": "string",
- "event_id": {
- "int32": 0,
- "valid": true
}, - "execution_time": "2019-08-24T14:15:22Z",
- "start_time": "2019-08-24T14:15:22Z",
- "end_time": "2019-08-24T14:15:22Z",
- "status": -1,
- "status_message": "string",
- "session_collection": true,
- "local_group_collection": true,
- "ad_structure_collection": true,
- "cert_services_collection": true,
- "ca_registry_collection": true,
- "dc_registry_collection": true,
- "all_trusted_domains": true,
- "domain_controller": "string",
- "ous": [
- {
- "distinguishedname": "string",
- "type": "string",
- "objectid": "string",
- "name": "string",
- "exists": true
}
], - "domains": [
- {
- "type": "string",
- "objectid": "string",
- "name": "string",
- "exists": true
}
], - "domain_results": [
- {
- "job_id": 0,
- "domain_name": "string",
- "success": true,
- "message": "string",
- "user_count": 0,
- "group_count": 0,
- "computer_count": 0,
- "gpo_count": 0,
- "ou_count": 0,
- "container_count": 0,
- "aiaca_count": 0,
- "rootca_count": 0,
- "enterpriseca_count": 0,
- "ntauthstore_count": 0,
- "certtemplate_count": 0,
- "deleted_count": 0,
- "id": 0,
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z",
- "deleted_at": {
- "time": "2019-08-24T14:15:22Z",
- "valid": true
}
}
], - "id": 0
}
}Get the log file from a SharpHound run
| job_id required | integer <int64> Job ID |
| Prefer | integer [ 0 .. 60 ] Default: 30 Prefer header, used to specify a custom timeout in seconds using the wait parameter as per RFC7240. The default timeout is 30 seconds and maximum timeout is 60 seconds |
{- "data": {
- "log": "string"
}
}Gets all client scheduled events.
| sort_by | string (sort-by) Sortable columns are |
| id | integer (filter.integer) Filter results by column integer value. Valid filter predicates are |
| rrule | string (filter.string) Filter results by column string value. Valid filter predicates are |
| next_scheduled_at | string <date-time> (filter.time) Filter results by column timestamp value formatted as an RFC-3339 string.
Valid filter predicates are |
| client_id | string <uuid> (filter.uuid) Filter results by column string-formatted uuid value. Valid filter predicates are |
| session_collection | boolean (filter.boolean) Filter results by column boolean value. Valid filter predicates are |
| local_group_collection | boolean (filter.boolean) Filter results by column boolean value. Valid filter predicates are |
| ad_structure_collection | boolean (filter.boolean) Filter results by column boolean value. Valid filter predicates are |
| cert_services_collection | boolean (filter.boolean) Filter results by column boolean value. Valid filter predicates are |
| ca_registry_collection | boolean (filter.boolean) Filter results by column boolean value. Valid filter predicates are |
| dc_registry_collection | boolean (filter.boolean) Filter results by column boolean value. Valid filter predicates are |
| hydrate_domains | boolean Default: true When a value of |
| hydrate_ous | boolean Default: true When a value of |
| created_at | string <date-time> (filter.time) Filter results by |
| updated_at | string <date-time> (filter.time) Filter results by |
| deleted_at | string <date-time> (filter.time) Filter results by |
| skip | integer (skip) >= 0 This query parameter is used for determining the number of objects to skip in pagination. |
| limit | integer (limit) >= 0 This query parameter is used for setting an upper limit of objects returned in paginated responses. |
| Prefer | integer [ 0 .. 60 ] Default: 30 Prefer header, used to specify a custom timeout in seconds using the wait parameter as per RFC7240. The default timeout is 30 seconds and maximum timeout is 60 seconds |
{- "count": 0,
- "skip": 0,
- "limit": 0,
- "data": [
- {
- "client_id": "5b3fa7ba-57d3-4017-a65b-d57dcd2db643",
- "rrule": "string",
- "session_collection": true,
- "local_group_collection": true,
- "ad_structure_collection": true,
- "cert_services_collection": true,
- "ca_registry_collection": true,
- "dc_registry_collection": true,
- "all_trusted_domains": true,
- "ous": [
- {
- "distinguishedname": "string",
- "type": "string",
- "objectid": "string",
- "name": "string",
- "exists": true
}
], - "domains": [
- {
- "type": "string",
- "objectid": "string",
- "name": "string",
- "exists": true
}
], - "id": 0
}
]
}Creates a scheduled event for data collection
| Prefer | integer [ 0 .. 60 ] Default: 30 Prefer header, used to specify a custom timeout in seconds using the wait parameter as per RFC7240. The default timeout is 30 seconds and maximum timeout is 60 seconds |
The request body for creating an event
| rrule | string |
| session_collection | boolean |
| local_group_collection | boolean |
| ad_structure_collection | boolean |
| cert_services_collection | boolean |
| ca_registry_collection | boolean |
| dc_registry_collection | boolean |
| all_trusted_domains | boolean |
| ous | Array of strings |
| domains | Array of strings |
{- "rrule": "string",
- "session_collection": true,
- "local_group_collection": true,
- "ad_structure_collection": true,
- "cert_services_collection": true,
- "ca_registry_collection": true,
- "dc_registry_collection": true,
- "all_trusted_domains": true,
- "ous": [
- "string"
], - "domains": [
- "string"
]
}{- "data": {
- "client_id": "5b3fa7ba-57d3-4017-a65b-d57dcd2db643",
- "rrule": "string",
- "session_collection": true,
- "local_group_collection": true,
- "ad_structure_collection": true,
- "cert_services_collection": true,
- "ca_registry_collection": true,
- "dc_registry_collection": true,
- "all_trusted_domains": true,
- "ous": [
- {
- "distinguishedname": "string",
- "type": "string",
- "objectid": "string",
- "name": "string",
- "exists": true
}
], - "domains": [
- {
- "type": "string",
- "objectid": "string",
- "name": "string",
- "exists": true
}
], - "id": 0
}
}Gets a scheduled job event by ID.
| event_id required | integer <int32> Event ID |
| Prefer | integer [ 0 .. 60 ] Default: 30 Prefer header, used to specify a custom timeout in seconds using the wait parameter as per RFC7240. The default timeout is 30 seconds and maximum timeout is 60 seconds |
{- "data": {
- "client_id": "5b3fa7ba-57d3-4017-a65b-d57dcd2db643",
- "rrule": "string",
- "session_collection": true,
- "local_group_collection": true,
- "ad_structure_collection": true,
- "cert_services_collection": true,
- "ca_registry_collection": true,
- "dc_registry_collection": true,
- "all_trusted_domains": true,
- "ous": [
- {
- "distinguishedname": "string",
- "type": "string",
- "objectid": "string",
- "name": "string",
- "exists": true
}
], - "domains": [
- {
- "type": "string",
- "objectid": "string",
- "name": "string",
- "exists": true
}
], - "id": 0
}
}Updates a scheduled event
| event_id required | integer <int32> Event ID |
| Prefer | integer [ 0 .. 60 ] Default: 30 Prefer header, used to specify a custom timeout in seconds using the wait parameter as per RFC7240. The default timeout is 30 seconds and maximum timeout is 60 seconds |
The request body for updating an event
| rrule | string |
| session_collection | boolean |
| local_group_collection | boolean |
| ad_structure_collection | boolean |
| cert_services_collection | boolean |
| ca_registry_collection | boolean |
| dc_registry_collection | boolean |
| all_trusted_domains | boolean |
| ous | Array of strings |
| domains | Array of strings |
{- "rrule": "string",
- "session_collection": true,
- "local_group_collection": true,
- "ad_structure_collection": true,
- "cert_services_collection": true,
- "ca_registry_collection": true,
- "dc_registry_collection": true,
- "all_trusted_domains": true,
- "ous": [
- "string"
], - "domains": [
- "string"
]
}{- "data": {
- "client_id": "5b3fa7ba-57d3-4017-a65b-d57dcd2db643",
- "rrule": "string",
- "session_collection": true,
- "local_group_collection": true,
- "ad_structure_collection": true,
- "cert_services_collection": true,
- "ca_registry_collection": true,
- "dc_registry_collection": true,
- "all_trusted_domains": true,
- "ous": [
- {
- "distinguishedname": "string",
- "type": "string",
- "objectid": "string",
- "name": "string",
- "exists": true
}
], - "domains": [
- {
- "type": "string",
- "objectid": "string",
- "name": "string",
- "exists": true
}
], - "id": 0
}
}Deletes a scheduled event and associated tasks by id
| event_id required | integer <int32> Event ID |
| Prefer | integer [ 0 .. 60 ] Default: 30 Prefer header, used to specify a custom timeout in seconds using the wait parameter as per RFC7240. The default timeout is 30 seconds and maximum timeout is 60 seconds |
[this request has no response data]
Export the finding table for a given attack path
| domain_id required | string Domain ID |
| finding required | string Finding Type |
| filterAccepted | string (risk-acceptance) Enum: "accepted" "unaccepted" "all" "" Risk acceptance filter |
| sort_by | string (sort-by) Sort by column. The only sortable column is |
| Prefer | integer [ 0 .. 60 ] Default: 30 Prefer header, used to specify a custom timeout in seconds using the wait parameter as per RFC7240. The default timeout is 30 seconds and maximum timeout is 60 seconds |
header1,header2,header3 cell1,cell2,cell3 cell4,cell5,cell6 ...
Lists all possible attack path types
| sort_by | string (sort-by) Sort by column. The only sortable column is |
| finding | string (filter.string) Filter results by column string value. Valid filter predicates are |
| Prefer | integer [ 0 .. 60 ] Default: 30 Prefer header, used to specify a custom timeout in seconds using the wait parameter as per RFC7240. The default timeout is 30 seconds and maximum timeout is 60 seconds |
{- "data": [
- "string"
]
}Starts generating attack paths
| Prefer | integer [ 0 .. 60 ] Default: 30 Prefer header, used to specify a custom timeout in seconds using the wait parameter as per RFC7240. The default timeout is 30 seconds and maximum timeout is 60 seconds |
[this request has no response data]
Lists available attack path types for a domain
| domain_id required | string Domain ID |
| sort_by | string (sort-by) Sort by column. The only sortable column is |
| finding | string (filter.string) Filter results by column string value. Valid filter predicates are |
| Prefer | integer [ 0 .. 60 ] Default: 30 Prefer header, used to specify a custom timeout in seconds using the wait parameter as per RFC7240. The default timeout is 30 seconds and maximum timeout is 60 seconds |
{- "data": [
- "string"
]
}Lists detailed data about attack paths for a domain.
| domain_id required | string Domain ID |
| finding | string (filter.string) Filter results by column string value. Valid filter predicates are |
| sort_by | string (sort-by) Sortable columns are |
| FromPrincipal | string (filter.string) Deprecated Filter results by column string value. Valid filter predicates are |
| ToPrincipal | string (filter.string) Deprecated Filter results by column string value. Valid filter predicates are |
| from_principal | string (filter.string) Filter results by column string value. Valid filter predicates are |
| to_principal | string (filter.string) Filter results by column string value. Valid filter predicates are |
| principals_hash | string (filter.string) Filter results by column string value. Valid filter predicates are |
| Accepted | string (filter.string) Filter results by column string value. Valid filter predicates are |
| AcceptedUntil | string <date-time> (filter.time) Deprecated Filter results by column timestamp value formatted as an RFC-3339 string.
Valid filter predicates are |
| accepted_until | string <date-time> (filter.time) Filter results by column timestamp value formatted as an RFC-3339 string.
Valid filter predicates are |
| Principal | string (filter.string) Filter results by column string value. Valid filter predicates are |
| Finding | string (filter.string) Filter results by column string value. Valid filter predicates are |
| domain_sid | string (filter.string) Filter results by column string value. Valid filter predicates are |
| id | integer (filter.integer) Filter results by column integer value. Valid filter predicates are |
| created_at | string <date-time> (filter.time) Filter results by |
| updated_at | string <date-time> (filter.time) Filter results by |
| deleted_at | string <date-time> (filter.time) Filter results by |
| skip | integer (skip) >= 0 This query parameter is used for determining the number of objects to skip in pagination. |
| limit | integer (limit) >= 0 This query parameter is used for setting an upper limit of objects returned in paginated responses. |
| Prefer | integer [ 0 .. 60 ] Default: 30 Prefer header, used to specify a custom timeout in seconds using the wait parameter as per RFC7240. The default timeout is 30 seconds and maximum timeout is 60 seconds |
{- "count": 0,
- "skip": 0,
- "limit": 0,
- "data": [
- {
- "Principal": "string",
- "PrincipalKind": "string",
- "Finding": "string",
- "DomainSID": "string",
- "Props": {
- "property1": { },
- "property2": { }
}, - "accepted_until": "2019-08-24T14:15:22Z",
- "id": 0,
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z",
- "deleted_at": {
- "time": "2019-08-24T14:15:22Z",
- "valid": true
}, - "Accepted": true
}
]
}List the values that represent the sparklines for individual attack paths
| domain_id required | string Domain ID |
| sort_by | string (sort-by) Sortable columns are |
| finding required | string (filter.string) Filter results by column string value. Valid filter predicates are |
| from | string <date-time> (filter.time) Beginning datetime of range (inclusive) in RFC-3339 format; Defaults to current datetime minus 30 days |
| to | string <date-time> (filter.time) Ending datetime of range (exclusive) in RFC-3339 format; Defaults to current datetime |
| Prefer | integer [ 0 .. 60 ] Default: 30 Prefer header, used to specify a custom timeout in seconds using the wait parameter as per RFC7240. The default timeout is 30 seconds and maximum timeout is 60 seconds |
{- "start": "2019-08-24T14:15:22Z",
- "end": "2019-08-24T14:15:22Z",
- "data": [
- {
- "CompositeRisk": 0.1,
- "FindingCount": 0,
- "ImpactedAssetCount": 0,
- "DomainSID": "string",
- "Finding": "string",
- "id": 0,
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z",
- "deleted_at": {
- "time": "2019-08-24T14:15:22Z",
- "valid": true
}
}
]
}Updates an attack path as an accepted or unaccepted risk until a given time.
| attack_path_id required | integer <int64> Attack Path ID |
| Prefer | integer [ 0 .. 60 ] Default: 30 Prefer header, used to specify a custom timeout in seconds using the wait parameter as per RFC7240. The default timeout is 30 seconds and maximum timeout is 60 seconds |
The request body for updating risk acceptance
| risk_type | string |
| accept_until | string <date-time> |
| accepted | boolean |
{- "risk_type": "string",
- "accept_until": "2019-08-24T14:15:22Z",
- "accepted": true
}{- "data": {
- "Principal": "string",
- "PrincipalKind": "string",
- "Finding": "string",
- "DomainSID": "string",
- "Props": {
- "property1": { },
- "property2": { }
}, - "accepted_until": "2019-08-24T14:15:22Z",
- "id": 0,
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z",
- "deleted_at": {
- "time": "2019-08-24T14:15:22Z",
- "valid": true
}
}
}Gets the history of database stats saved in the database
| sort_by | string (sort-by) Sortable columns are |
| from | string <date-time> Deprecated Lower bound for created_at; to return posture stats starting at a specific date/time |
| to | string <date-time> Deprecated Upper bound for created_at; to return posture stats upto a specific date/time |
| domain_sid | string (filter.string) Filter results by column string value. Valid filter predicates are |
| exposure_index | integer (filter.integer) Filter results by column integer value. Valid filter predicates are |
| tier_zero_count | integer (filter.integer) Filter results by column integer value. Valid filter predicates are |
| critical_risk_count | integer (filter.integer) Filter results by column integer value. Valid filter predicates are |
| id | integer (filter.integer) Filter results by column integer value. Valid filter predicates are |
| Prefer | integer [ 0 .. 60 ] Default: 30 Prefer header, used to specify a custom timeout in seconds using the wait parameter as per RFC7240. The default timeout is 30 seconds and maximum timeout is 60 seconds |
{- "count": 0,
- "skip": 0,
- "limit": 0,
- "start": "2019-08-24T14:15:22Z",
- "end": "2019-08-24T14:15:22Z",
- "data": [
- {
- "domain_sid": "string",
- "exposure_index": 0.1,
- "tier_zero_count": 0,
- "critical_risk_count": 0,
- "id": 0,
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z",
- "deleted_at": {
- "time": "2019-08-24T14:15:22Z",
- "valid": true
}
}
]
}Get info and counts for this Meta node.
| object_id required | string (object-id) The object id of the entity being operated on. |
| Prefer | integer [ 0 .. 60 ] Default: 30 Prefer header, used to specify a custom timeout in seconds using the wait parameter as per RFC7240. The default timeout is 30 seconds and maximum timeout is 60 seconds |
{- "data": {
- "props": {
- "property1": { },
- "property2": { }
}
}
}